1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 323642 $ -->
<section xml:id="wincache.configuration" xmlns="http://docbook.org/ns/docbook">
&reftitle.runtime;
&extension.runtime;
<para>
The following table lists and explains the configuration settings
provided by the WinCache extension:
</para>
<para>
<table>
<title>WinCache configuration options</title>
<tgroup cols="6">
<thead>
<row>
<entry>&Name;</entry>
<entry>&Default;</entry>
<entry>Minimum</entry>
<entry>Maximum</entry>
<entry>&Changeable;</entry>
<entry>&Changelog;</entry>
</row>
</thead>
<tbody>
<row>
<entry><link linkend="ini.wincache.fcenabled">wincache.fcenabled</link></entry>
<entry>"1"</entry>
<entry>"0"</entry>
<entry>"1"</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since WinCache 1.0.0</entry>
</row>
<row>
<entry><link linkend="ini.wincache.fcenabledfilter">wincache.fcenabledfilter</link></entry>
<entry>"NULL"</entry>
<entry>"NULL"</entry>
<entry>"NULL"</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry>Available since WinCache 1.0.0</entry>
</row>
<row>
<entry><link linkend="ini.wincache.fcachesize">wincache.fcachesize</link></entry>
<entry>"24"</entry>
<entry>"5"</entry>
<entry>"255"</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry>Available since WinCache 1.0.0</entry>
</row>
<row>
<entry><link linkend="ini.wincache.fcndetect">wincache.fcndetect</link></entry>
<entry>"1"</entry>
<entry>"0"</entry>
<entry>"1"</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry>Available since WinCache 1.1.0</entry>
</row>
<row>
<entry><link linkend="ini.wincache.maxfilesize">wincache.maxfilesize</link></entry>
<entry>"256"</entry>
<entry>"10"</entry>
<entry>"2048"</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry>Available since WinCache 1.0.0</entry>
</row>
<row>
<entry><link linkend="ini.wincache.ocenabled">wincache.ocenabled</link></entry>
<entry>"1"</entry>
<entry>"0"</entry>
<entry>"1"</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since WinCache 1.0.0</entry>
</row>
<row>
<entry><link linkend="ini.wincache.ocenabledfilter">wincache.ocenabledfilter</link></entry>
<entry>"NULL"</entry>
<entry>"NULL"</entry>
<entry>"NULL"</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry>Available since WinCache 1.0.0</entry>
</row>
<row>
<entry><link linkend="ini.wincache.ocachesize">wincache.ocachesize</link></entry>
<entry>"96"</entry>
<entry>"15"</entry>
<entry>"255"</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry>Available since WinCache 1.0.0</entry>
</row>
<row>
<entry><link linkend="ini.wincache.filecount">wincache.filecount</link></entry>
<entry>"4096"</entry>
<entry>"1024"</entry>
<entry>"16384"</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry>Available since WinCache 1.0.0</entry>
</row>
<row>
<entry><link linkend="ini.wincache.chkinterval">wincache.chkinterval</link></entry>
<entry>"30"</entry>
<entry>"0"</entry>
<entry>"300"</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry>Available since WinCache 1.0.0</entry>
</row>
<row>
<entry><link linkend="ini.wincache.ttlmax">wincache.ttlmax</link></entry>
<entry>"1200"</entry>
<entry>"0"</entry>
<entry>"7200"</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry>Available since WinCache 1.0.0</entry>
</row>
<row>
<entry><link linkend="ini.wincache.enablecli">wincache.enablecli</link></entry>
<entry>0</entry>
<entry>0</entry>
<entry>1</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry>Available since WinCache 1.0.0</entry>
</row>
<row>
<entry><link linkend="ini.wincache.ignorelist">wincache.ignorelist</link></entry>
<entry>NULL</entry>
<entry>NULL</entry>
<entry>NULL</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available since WinCache 1.0.0</entry>
</row>
<row>
<entry><link linkend="ini.wincache.namesalt">wincache.namesalt</link></entry>
<entry>NULL</entry>
<entry>NULL</entry>
<entry>NULL</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry>Available since WinCache 1.0.0</entry>
</row>
<row>
<entry><link linkend="ini.wincache.ucenabled">wincache.ucenabled</link></entry>
<entry>1</entry>
<entry>0</entry>
<entry>1</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry>Available since WinCache 1.1.0</entry>
</row>
<row>
<entry><link linkend="ini.wincache.namesalt">wincache.ucachesize</link></entry>
<entry>8</entry>
<entry>5</entry>
<entry>85</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry>Available since WinCache 1.1.0</entry>
</row>
<row>
<entry><link linkend="ini.wincache.namesalt">wincache.scachesize</link></entry>
<entry>8</entry>
<entry>5</entry>
<entry>85</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry>Available since WinCache 1.1.0</entry>
</row>
<row>
<entry><link linkend="ini.wincache.rerouteini">wincache.rerouteini</link></entry>
<entry>NULL</entry>
<entry>NULL</entry>
<entry>NULL</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry>Available since WinCache 1.2.0</entry>
</row>
</tbody>
</tgroup>
</table>
&ini.php.constants;
</para>
&ini.descriptions.title;
<para>
<variablelist>
<varlistentry xml:id="ini.wincache.fcenabled">
<term>
<parameter>wincache.fcenabled</parameter>
<type>boolean</type>
</term>
<listitem>
<simpara>Enables or disables the file cache functionality.</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.wincache.fcenabledfilter">
<term>
<parameter>wincache.fcenabledfilter</parameter>
<type>string</type>
</term>
<listitem>
<simpara>
Defines a comma-separated list of IIS web site identifiers where file
cache should be enabled or disabled. This setting works in conjunction
with <literal>wincache.fcenabled</literal>: if <literal>wincache.fcenabled</literal>
is set to 1, then the sites listed in the <literal>wincache.fcenabledfilter</literal>
will have the file cache turned off; if <literal>wincache.fcenabled</literal>
is set to 0, then the sites listed in the <literal>wincache.fcenabledfilter</literal>
will have the file cache turned on.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.wincache.fcachesize">
<term>
<parameter>wincache.fcachesize</parameter>
<type>integer</type>
</term>
<listitem>
<simpara>
Defines the maximum memory size (in megabytes) that is allocated for the file cache.
If the total size of all the cached files exceeds the value specified in this setting,
then most stale files will be removed from the file cache.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.wincache.fcndetect">
<term>
<parameter>wincache.fcndetect</parameter>
<type>boolean</type>
</term>
<listitem>
<simpara>
Enables or disables the file change notification detection functionality. If file change
notification is supported then it will be used to refresh the opcode and file cache entries
as soon as the corresponding files are modified on a file system. If file change notification
is not supported, for example when using network file shares, then wincache will poll for
file changes at regular time intervals specified by <literal>wincache.chkinterval</literal>.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.wincache.maxfilesize">
<term>
<parameter>wincache.maxfilesize</parameter>
<type>integer</type>
</term>
<listitem>
<simpara>
Defines the maximum allowed size (in kilobytes) for a single file to be cached.
If a file size exceeds the specified value, the file will not be cached.
This setting applies to the file cache only.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.wincache.ocenabled">
<term>
<parameter>wincache.ocenabled</parameter>
<type>boolean</type>
</term>
<listitem>
<simpara>Enables or disables the opcode cache functionality</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.wincache.ocenabledfilter">
<term>
<parameter>wincache.ocenabledfilter</parameter>
<type>string</type>
</term>
<listitem>
<simpara>
Defines a comma-separated list of IIS web site identifiers where opcode
cache should be enabled or disabled. This setting works in conjunction
with <literal>wincache.ocenabled</literal>: if <literal>wincache.ocenabled</literal>
is set to 1, then the sites listed in the <literal>wincache.ocenabledfilter</literal>
will have the opcode cache turned off; if <literal>wincache.ocenabled</literal>
is set to 0, then the sites listed in the <literal>wincache.ocenabledfilter</literal>
will have the opcode cache turned on.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.wincache.ocachesize">
<term>
<parameter>wincache.ocachesize</parameter>
<type>integer</type>
</term>
<listitem>
<simpara>
Defines the maximum memory size (in megabytes) that is allocated for the
opcode cache. If the cached opcode size exceeds the specified value,
then most stale opcode will be removed from the cache. Note that the opcode
cache size must be at least 3 times bigger than file cache size.
If that is not the case the opcode cache size will be automatically increased.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.wincache.filecount">
<term>
<parameter>wincache.filecount</parameter>
<type>integer</type>
</term>
<listitem>
<simpara>
Defines how many files are expected to be cached by the extension, so that appropriate
memory size is allocated at the startup time. If the number of files exceeds the specified
value, the WinCache will re-allocate more memory as needed.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.wincache.chkinterval">
<term>
<parameter>wincache.chkinterval</parameter>
<type>integer</type>
</term>
<listitem>
<simpara>
Defines how often (in seconds) the extension checks for file changes in order
to refresh the cache. Setting it to 0 will disable the refreshing of the cache.
The file changes will not be reflected in the cache unless the cache entry for
that file is removed by scavenger or IIS application pool is recycled or
wincache_refresh_if_changed function is called.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.wincache.ttlmax">
<term>
<parameter>wincache.ttlmax</parameter>
<type>integer</type>
</term>
<listitem>
<simpara>
Defines the maximum time to live (in seconds) for a cached entry without being used.
Setting it to 0 will disable the cache scavenger, so the cached entries will never
be removed from the cache during the lifetime of the IIS worker process.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.wincache.enablecli">
<term>
<parameter>wincache.enablecli</parameter>
<type>boolean</type>
</term>
<listitem>
<simpara>
Defines if caching is enabled when PHP is running in command line (CLI) mode.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.wincache.ignorelist">
<term>
<parameter>wincache.ignorelist</parameter>
<type>string</type>
</term>
<listitem>
<para>
Defines a list of files that should not be cached by the extension.
The files list is specified by using file names only, separated by
the pipe symbol - "|".
<example>
<title><literal>wincache.ignorelist</literal> example</title>
<programlisting role="ini">
<![CDATA[
wincache.ignorelist = "index.php|misc.php|admin.php"
]]>
</programlisting>
</example>
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.wincache.namesalt">
<term>
<parameter>wincache.namesalt</parameter>
<type>string</type>
</term>
<listitem>
<simpara>
Defines a string that will be used when naming the extension
specific objects that are stored in shared memory. This is used
to avoid conflicts that may be caused if other applications within
an IIS worker process tries to access shared memory. The length of
the namesalt string cannot exceed 8 characters.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.wincache.ucenabled">
<term>
<parameter>wincache.ucenabled</parameter>
<type>boolean</type>
</term>
<listitem>
<simpara>
Enables or disables the user cache functionality.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.wincache.ucachesize">
<term>
<parameter>wincache.ucachesize</parameter>
<type>integer</type>
</term>
<listitem>
<simpara>
Defines the maximum memory size in megabytes that is allocated for the user cache. If the total
size of variables stored in the user cache exceeds the specified value, then the most stale variables
will be removed from the cache.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.wincache.scachesize">
<term>
<parameter>wincache.scachesize</parameter>
<type>integer</type>
</term>
<listitem>
<simpara>
Defines the maximum memory size in megabytes that is allocated for the session cache. If the total
size of data stored in the session cache exceeds the specified value, then the most stale data
will be removed from the cache.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.wincache.rerouteini">
<term>
<parameter>wincache.rerouteini</parameter>
<type>string</type>
</term>
<listitem>
<simpara>
Specifies an absolute or a relateve path to the reroute.ini file that contains the list of PHP functions
whose implementation should be replaced with the WinCache function equivalents. If a relative path is specified
then it is assumed to be relative to the location of php-cgi.exe file.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
