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
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<sect1 id="zend.cache.backends">
<title>Zend_Cache Backends</title>
<para>
There are two kinds of backends: standard ones and extended ones. Of course, extended
backends offer more features.
</para>
<sect2 id="zend.cache.backends.file">
<title>Zend_Cache_Backend_File</title>
<para>
This (extended) backends stores cache records into files (in a chosen directory).
</para>
<para>
Available options are :
</para>
<table id="zend.cache.backends.file.table">
<title>File Backend Options</title>
<tgroup cols="4">
<thead>
<row>
<entry>Option</entry>
<entry>Data Type</entry>
<entry>Default Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><emphasis>cache_dir</emphasis></entry>
<entry><type>String</type></entry>
<entry>[system temp dir]</entry>
<entry>Directory where to store cache files</entry>
</row>
<row>
<entry><emphasis>file_locking</emphasis></entry>
<entry><type>Boolean</type></entry>
<entry><constant>TRUE</constant></entry>
<entry>
Enable or disable file_locking : Can avoid cache corruption under
bad circumstances but it doesn't help on multithread webservers
or on <acronym>NFS</acronym> filesystems...
</entry>
</row>
<row>
<entry><emphasis>read_control</emphasis></entry>
<entry><type>Boolean</type></entry>
<entry><constant>TRUE</constant></entry>
<entry>
Enable / disable read control : if enabled, a control key is
embedded in the cache file and this key is compared with the
one calculated after the reading.
</entry>
</row>
<row>
<entry><emphasis>read_control_type</emphasis></entry>
<entry><type>String</type></entry>
<entry>'crc32'</entry>
<entry>
Type of read control (only if read control is enabled). Available values
are : 'md5' (best but slowest), 'crc32' (lightly less safe but faster,
better choice), 'adler32' (new choice, faster than crc32),
'strlen' for a length only test (fastest).
</entry>
</row>
<row>
<entry><emphasis>hashed_directory_level</emphasis></entry>
<entry><type>Integer</type></entry>
<entry>0</entry>
<entry>
Hashed directory structure level : 0 means "no hashed directory
structure", 1 means "one level of directory", 2 means "two levels"...
This option can speed up the cache only when you have many thousands of
cache files. Only specific benchs can help you to choose the perfect
value for you. Maybe, 1 or 2 is a good start.
</entry>
</row>
<row>
<entry><emphasis>hashed_directory_perm</emphasis></entry>
<entry><type>Integer</type></entry>
<entry>0700</entry>
<entry>Permissins for the hashed directory structure</entry>
</row>
<row>
<entry><emphasis>file_name_prefix</emphasis></entry>
<entry><type>String</type></entry>
<entry>'zend_cache'</entry>
<entry>
prefix for cache files ; be really careful with this option because
a too generic value in a system cache dir
(like <filename>/tmp</filename>) can cause disasters when cleaning
the cache
</entry>
</row>
<row>
<entry><emphasis>cache_file_umask</emphasis></entry>
<entry><type>Integer</type></entry>
<entry>0600</entry>
<entry>umask for cache files</entry>
</row>
<row>
<entry><emphasis>cache_file_perm</emphasis></entry>
<entry><type>Integer</type></entry>
<entry>0600</entry>
<entry>Permissions for cache files</entry>
</row>
<row>
<entry><emphasis>metatadatas_array_max_size</emphasis></entry>
<entry><type>Integer</type></entry>
<entry>100</entry>
<entry>
internal max size for the metadatas array (don't change this value
unless you know what you are doing)
</entry>
</row>
</tbody>
</tgroup>
</table>
</sect2>
<sect2 id="zend.cache.backends.sqlite">
<title>Zend_Cache_Backend_Sqlite</title>
<para>
This (extended) backends stores cache records into a SQLite database.
</para>
<para>
Available options are :
</para>
<table id="zend.cache.backends.sqlite.table">
<title>Sqlite Backend Options</title>
<tgroup cols="4">
<thead>
<row>
<entry>Option</entry>
<entry>Data Type</entry>
<entry>Default Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><emphasis>cache_db_complete_path (mandatory)</emphasis></entry>
<entry><type>String</type></entry>
<entry><constant>NULL</constant></entry>
<entry>
The complete path (filename included) of the SQLite database
</entry>
</row>
<row>
<entry><emphasis>automatic_vacuum_factor</emphasis></entry>
<entry><type>Integer</type></entry>
<entry>10</entry>
<entry>
Disable / Tune the automatic vacuum process. The automatic vacuum
process defragment the database file (and make it smaller) when a
<methodname>clean()</methodname> or <methodname>delete()</methodname>
is called: 0 means no automatic vacuum ; 1 means systematic vacuum
(when <methodname>delete()</methodname> or
<methodname>clean()</methodname> methods are called) ; x (integer) >
1 => automatic vacuum randomly 1 times on x
<methodname>clean()</methodname> or
<methodname>delete()</methodname>.
</entry>
</row>
</tbody>
</tgroup>
</table>
</sect2>
<sect2 id="zend.cache.backends.memcached">
<title>Zend_Cache_Backend_Memcached</title>
<para>
This (extended) backends stores cache records into a memcached server. <ulink
url="http://www.danga.com/memcached/">memcached</ulink> is a high-performance,
distributed memory object caching system. To use this backend, you need a memcached
daemon and <ulink url="http://pecl.php.net/package/memcache">the memcache
<acronym>PECL</acronym> extension</ulink>.
</para>
<para>
Be careful : with this backend, "tags" are not supported for the moment as
the "doNotTestCacheValidity=true" argument.
</para>
<para>
Available options are :
</para>
<table id="zend.cache.backends.memcached.table">
<title>Memcached Backend Options</title>
<tgroup cols="4">
<thead>
<row>
<entry>Option</entry>
<entry>Data Type</entry>
<entry>Default Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><emphasis>servers</emphasis></entry>
<entry><type>Array</type></entry>
<entry>
<command>array(array('host' => 'localhost', 'port' => 11211,
'persistent' => true, 'weight' => 1, 'timeout' => 5,
'retry_interval' => 15, 'status' => true,
'failure_callback' => '' ))</command>
</entry>
<entry>
An array of memcached servers ; each memcached server is described by
an associative array : 'host' => (string) : the name of the memcached
server, 'port' => (int) : the port of the memcached server,
'persistent' => (bool) : use or not persistent connections to this
memcached server 'weight' => (int) :the weight of the memcached
server, 'timeout' => (int) :the time out of the memcached server,
'retry_interval' => (int) :the retry interval of the memcached server,
'status' => (bool) :the status of the memcached server,
'failure_callback' => (callback) : the failure_callback of the
memcached server
</entry>
</row>
<row>
<entry><emphasis>compression</emphasis></entry>
<entry><type>Boolean</type></entry>
<entry><constant>FALSE</constant></entry>
<entry>
<constant>TRUE</constant> if you want to use on-the-fly compression
</entry>
</row>
<row>
<entry><emphasis>compatibility</emphasis></entry>
<entry><type>Boolean</type></entry>
<entry><constant>FALSE</constant></entry>
<entry>
<constant>TRUE</constant> if you want to use this compatibility mode
with old memcache servers or extensions
</entry>
</row>
</tbody>
</tgroup>
</table>
</sect2>
<sect2 id="zend.cache.backends.libmemcached">
<title>Zend_Cache_Backend_Libmemcached</title>
<para>
This (extended) backend stores cache records into a memcached server. <ulink
url="http://www.danga.com/memcached/">memcached</ulink> is a high-performance,
distributed memory object caching system. To use this backend, you need a memcached
daemon and <ulink url="http://pecl.php.net/package/memcached">the memcached
<acronym>PECL</acronym> extension</ulink>.
</para>
<para>
Be careful : with this backend, "tags" are not supported for the moment as
the "doNotTestCacheValidity=true" argument.
</para>
<para>
Available options are :
</para>
<table id="zend.cache.backends.libmemcached.table">
<title>Libmemcached Backend Options</title>
<tgroup cols="4">
<thead>
<row>
<entry>Option</entry>
<entry>Data Type</entry>
<entry>Default Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><emphasis>servers</emphasis></entry>
<entry><type>Array</type></entry>
<entry>
<command>array(array('host' => 'localhost', 'port' => 11211,
'weight' => 1))</command>
</entry>
<entry>
An array of memcached servers ; each memcached server is described by
an associative array:
'host' => (string) : the name of the memcached server,
'port' => (int) : the port of the memcached server,
'weight' => (int) :the weight of the memcached server
</entry>
</row>
<row>
<entry><emphasis>client</emphasis></entry>
<entry><type>Array</type></entry>
<entry>
<command>array(
Memcached::OPT_DISTRIBUTION => Memcached::DISTRIBUTION_CONSISTENT,
Memcached::OPT_HASH => Memcached::HASH_MD5,
Memcached::OPT_LIBKETAMA_COMPATIBLE => true
)</command>
</entry>
<entry>
An associative array of memcached client options ;
The array key can be the name of the memcached option constant
(without 'OPT_') or the integer value of it.
See <ulink url="http://php.net/manual/memcached.constants.php">
Memcached constants on <acronym>PHP</acronym> manual</ulink>
</entry>
</row>
</tbody>
</tgroup>
</table>
</sect2>
<sect2 id="zend.cache.backends.apc">
<title>Zend_Cache_Backend_Apc</title>
<para>
This (extended) backends stores cache records in shared memory through
the <ulink url="http://pecl.php.net/package/APC">APC</ulink> (Alternative
<acronym>PHP</acronym> Cache) extension (which is of course need for using this
backend).
</para>
<para>
Be careful : with this backend, "tags" are not supported for the moment as
the "doNotTestCacheValidity=true" argument.
</para>
<para>
There is no option for this backend.
</para>
</sect2>
<sect2 id="zend.cache.backends.xcache">
<title>Zend_Cache_Backend_Xcache</title>
<para>
This backends stores cache records in shared memory through
the <ulink url="http://xcache.lighttpd.net/">XCache</ulink> extension
(which is of course need for using this backend).
</para>
<para>
Be careful : with this backend, "tags" are not supported for the moment as
the "doNotTestCacheValidity=true" argument.
</para>
<para>
Available options are :
</para>
<table id="zend.cache.backends.xcache.table">
<title>Xcache Backend Options</title>
<tgroup cols="4">
<thead>
<row>
<entry>Option</entry>
<entry>Data Type</entry>
<entry>Default Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><emphasis>user</emphasis></entry>
<entry><type>String</type></entry>
<entry><constant>NULL</constant></entry>
<entry>
<filename>xcache.admin.user</filename>, necessary for the
<methodname>clean()</methodname> method
</entry>
</row>
<row>
<entry><emphasis>password</emphasis></entry>
<entry><type>String</type></entry>
<entry><constant>NULL</constant></entry>
<entry>
<filename>xcache.admin.pass</filename> (in clear form, not
<acronym>MD5</acronym>), necessary for the
<methodname>clean()</methodname> method
</entry>
</row>
</tbody>
</tgroup>
</table>
</sect2>
<sect2 id="zend.cache.backends.platform">
<title>Zend_Cache_Backend_ZendPlatform</title>
<para>
This backend uses content caching <acronym>API</acronym> of the <ulink
url="http://www.zend.com/en/products/platform/">Zend Platform</ulink> product.
Naturally, to use this backend you need to have Zend Platform installed.
</para>
<para>
This backend supports tags, but does not support
<constant>CLEANING_MODE_NOT_MATCHING_TAG</constant> cleaning mode.
</para>
<para>
Specify this backend using a word separator -- '-', '.', ' ', or '_'
-- between the words 'Zend' and 'Platform' when using the
<methodname>Zend_Cache::factory()</methodname> method:
</para>
<programlisting language="php"><![CDATA[
$cache = Zend_Cache::factory('Core', 'Zend Platform');
]]></programlisting>
<para>
There are no options for this backend.
</para>
</sect2>
<sect2 id="zend.cache.backends.twolevels">
<title>Zend_Cache_Backend_TwoLevels</title>
<para>
This (extend) backend is an hybrid one. It stores cache records in two other backends :
a fast one (but limited) like Apc, Memcache... and a "slow" one like File, Sqlite...
</para>
<para>
This backend will use the priority parameter (given at the frontend level when storing a
record) and the remaining space in the fast backend to optimize the usage of these two
backends.
</para>
<para>
Specify this backend using a word separator -- '-', '.', ' ', or '_'
-- between the words 'Two' and 'Levels' when using the
<methodname>Zend_Cache::factory()</methodname> method:
</para>
<programlisting language="php"><![CDATA[
$cache = Zend_Cache::factory('Core', 'Two Levels');
]]></programlisting>
<para>
Available options are :
</para>
<table id="zend.cache.backends.twolevels.table">
<title>TwoLevels Backend Options</title>
<tgroup cols="4">
<thead>
<row>
<entry>Option</entry>
<entry>Data Type</entry>
<entry>Default Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><emphasis>slow_backend</emphasis></entry>
<entry><type>String</type></entry>
<entry>File</entry>
<entry>the "slow" backend name</entry>
</row>
<row>
<entry><emphasis>fast_backend</emphasis></entry>
<entry><type>String</type></entry>
<entry>Apc</entry>
<entry>the "fast" backend name</entry>
</row>
<row>
<entry><emphasis>slow_backend_options</emphasis></entry>
<entry><type>Array</type></entry>
<entry><methodname>array()</methodname></entry>
<entry>the "slow" backend options</entry>
</row>
<row>
<entry><emphasis>fast_backend_options</emphasis></entry>
<entry><type>Array</type></entry>
<entry><methodname>array()</methodname></entry>
<entry>the "fast" backend options</entry>
</row>
<row>
<entry><emphasis>slow_backend_custom_naming</emphasis></entry>
<entry><type>Boolean</type></entry>
<entry><constant>FALSE</constant></entry>
<entry>
if <constant>TRUE</constant>, the slow_backend argument is used as a
complete class name; if <constant>FALSE</constant>,
the frontend argument is used as the end of
"<classname>Zend_Cache_Backend_</classname>[...]" class name
</entry>
</row>
<row>
<entry><emphasis>fast_backend_custom_naming</emphasis></entry>
<entry><type>Boolean</type></entry>
<entry><constant>FALSE</constant></entry>
<entry>
if <constant>TRUE</constant>, the fast_backend argument is used as a
complete class name; if <constant>FALSE</constant>,
the frontend argument is used as the end of
"<classname>Zend_Cache_Backend_</classname>[...]" class name
</entry>
</row>
<row>
<entry><emphasis>slow_backend_autoload</emphasis></entry>
<entry><type>Boolean</type></entry>
<entry><constant>FALSE</constant></entry>
<entry>
if <constant>TRUE</constant>, there will no require_once for the
slow backend (useful only for custom backends)
</entry>
</row>
<row>
<entry><emphasis>fast_backend_autoload</emphasis></entry>
<entry><type>Boolean</type></entry>
<entry><constant>FALSE</constant></entry>
<entry>
if <constant>TRUE</constant>, there will no require_once for the fast
backend (useful only for custom backends)
</entry>
</row>
<row>
<entry><emphasis>auto_refresh_fast_cache</emphasis></entry>
<entry><type>Boolean</type></entry>
<entry><constant>TRUE</constant></entry>
<entry>
if <constant>TRUE</constant>, auto refresh the fast cache when a
cache record is hit
</entry>
</row>
<row>
<entry><emphasis>stats_update_factor</emphasis></entry>
<entry><type>Integer</type></entry>
<entry>10</entry>
<entry>
disable / tune the computation of the fast backend filling percentage
(when saving a record into cache, computation of the fast backend
filling percentage randomly 1 times on x cache writes)
</entry>
</row>
</tbody>
</tgroup>
</table>
</sect2>
<sect2 id="zend.cache.backends.zendserver">
<title>Zend_Cache_Backend_ZendServer_Disk and Zend_Cache_Backend_ZendServer_ShMem</title>
<para>
These backends store cache records using <ulink
url="http://www.zend.com/en/products/server/downloads-all?zfs=zf_download">Zend
Server</ulink> caching functionality.
</para>
<para>
Be careful: with these backends, "tags" are not supported for the moment as the
"doNotTestCacheValidity=true" argument.
</para>
<para>
These backend work only withing Zend Server environment for pages requested through
<acronym>HTTP</acronym> or <acronym>HTTPS</acronym> and don't work for command line
script execution
</para>
<para>
Specify this backend using parameter <emphasis>customBackendNaming</emphasis> as
<constant>TRUE</constant> when using the <methodname>Zend_Cache::factory()</methodname>
method:
</para>
<programlisting language="php"><![CDATA[
$cache = Zend_Cache::factory('Core', 'Zend_Cache_Backend_ZendServer_Disk',
$frontendOptions, $backendOptions, false, true);
]]></programlisting>
<para>
There is no option for this backend.
</para>
</sect2>
<sect2 id="zend.cache.backends.static">
<title>Zend_Cache_Backend_Static</title>
<para>
This backend works in concert with <classname>Zend_Cache_Frontend_Capture</classname>
(the two must be used together) to save the output from requests as static files. This
means the static files are served directly on subsequent requests without any
involvement of <acronym>PHP</acronym> or Zend Framework at all.
</para>
<note>
<para>
<classname>Zend_Cache_Frontend_Capture</classname> operates
by registering a callback function to be called
when the output buffering it uses is cleaned. In order for this to operate
correctly, it must be the final output buffer in the request. To guarantee
this, the output buffering used by the Dispatcher <emphasis>must</emphasis> be
disabled by calling <classname>Zend_Controller_Front</classname>'s
<methodname>setParam()</methodname> method, for example,
<command>$front->setParam('disableOutputBuffering', true);</command> or adding
"resources.frontcontroller.params.disableOutputBuffering = true"
to your bootstrap configuration file (assumed <acronym>INI</acronym>) if using
<classname>Zend_Application</classname>.
</para>
</note>
<para>
The benefits of this cache include a large throughput increase since
all subsequent requests return the static file and don't need any
dynamic processing. Of course this also has some disadvantages. The
only way to retry the dynamic request is to purge the cached file
from elsewhere in the application (or via a cronjob if timed). It
is also restricted to single-server applications where only one
filesystem is used. Nevertheless, it can be a powerful means of
getting more performance without incurring the cost of a proxy on
single machines.
</para>
<para>
Before describing its options, you should note this needs some
changes to the default <filename>.htaccess</filename> file in order for requests to be
directed to the static files if they exist. Here's an example of
a simple application caching some content, including two specific
feeds which need additional treatment to serve a correct
Content-Type header:
</para>
<programlisting language="text"><![CDATA[
AddType application/rss+xml .xml
AddType application/atom+xml .xml
RewriteEngine On
RewriteCond %{REQUEST_URI} feed/rss$
RewriteCond %{DOCUMENT_ROOT}/cached/%{REQUEST_URI}.xml -f
RewriteRule .* cached/%{REQUEST_URI}.xml [L,T=application/rss+xml]
RewriteCond %{REQUEST_URI} feed/atom$
RewriteCond %{DOCUMENT_ROOT}/cached/%{REQUEST_URI}.xml -f
RewriteRule .* cached/%{REQUEST_URI}.xml [L,T=application/atom+xml]
RewriteCond %{DOCUMENT_ROOT}/cached/index.html -f
RewriteRule ^/*$ cached/index.html [L]
RewriteCond %{DOCUMENT_ROOT}/cached/%{REQUEST_URI}.(html|xml|json|opml|svg) -f
RewriteRule .* cached/%{REQUEST_URI}.%1 [L]
RewriteCond %{REQUEST_FILENAME} -s [OR]
RewriteCond %{REQUEST_FILENAME} -l [OR]
RewriteCond %{REQUEST_FILENAME} -d
RewriteRule ^.*$ - [NC,L]
RewriteRule ^.*$ index.php [NC,L]
]]></programlisting>
<para>
The above assumes static files are cached to the directory
<filename>./public/cached</filename>. We'll cover the option setting this location,
"public_dir", below.
</para>
<para>
Due to the nature of static file caching, the backend class offers two additional
methods: <methodname>remove()</methodname> and
<methodname>removeRecursively()</methodname>. Both accept a request
<acronym>URI</acronym>, which when mapped to the "public_dir" where static files are
cached, and has a pre-stored extension appended, provides the name of either a static
file to delete, or a directory path to delete recursively. Due to the
restraints of <classname>Zend_Cache_Backend_Interface</classname>, all
other methods such as <methodname>save()</methodname> accept an ID which
is calculated by applying <methodname>bin2hex()</methodname> to a request
<acronym>URI</acronym>.
</para>
<para>
Given the level at which static caching operates, static file caching is addressed for
simpler use with the <classname>Zend_Controller_Action_Helper_Cache</classname> action
helper. This helper assists in setting which actions of a controller to cache, with what
tags, and with which extension. It also offers methods for purging the cache by request
<acronym>URI</acronym> or tag. Static file caching is also assisted by
<classname>Zend_Cache_Manager</classname> which includes pre-configured configuration
templates for a static cache (as <constant>Zend_Cache_Manager::PAGECACHE</constant> or
"page"). The defaults therein can be configured as needed to set up a "public_dir"
location for caching, etc.
</para>
<note>
<para>
It should be noted that the static cache actually uses a secondary cache to store
tags (obviously we can't store them elsewhere since a static cache does not invoke
<acronym>PHP</acronym> if working correctly). This is just a standard Core cache,
and should use a persistent backend such as File or TwoLevels (to take advantage of
memory storage without sacrificing permanent persistance). The backend includes the
option "tag_cache" to set this up (it is obligatory), or the
<methodname>setInnerCache()</methodname> method.
</para>
</note>
<table id="zend.cache.backends.static.table">
<title>Static Backend Options</title>
<tgroup cols="4">
<thead>
<row>
<entry>Option</entry>
<entry>Data Type</entry>
<entry>Default Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><emphasis>public_dir</emphasis></entry>
<entry><type>String</type></entry>
<entry><constant>NULL</constant></entry>
<entry>
Directory where to store static files. This must exist
in your public directory.
</entry>
</row>
<row>
<entry><emphasis>file_locking</emphasis></entry>
<entry><type>Boolean</type></entry>
<entry><constant>TRUE</constant></entry>
<entry>
Enable or disable file_locking : Can avoid cache corruption under
bad circumstances but it doesn't help on multithread webservers
or on <acronym>NFS</acronym> filesystems...
</entry>
</row>
<row>
<entry><emphasis>read_control</emphasis></entry>
<entry><type>Boolean</type></entry>
<entry><constant>TRUE</constant></entry>
<entry>
Enable / disable read control : if enabled, a control key is
embedded in the cache file and this key is compared with the
one calculated after the reading.
</entry>
</row>
<row>
<entry><emphasis>read_control_type</emphasis></entry>
<entry><type>String</type></entry>
<entry>'crc32'</entry>
<entry>
Type of read control (only if read control is enabled). Available values
are : 'md5' (best but slowest), 'crc32' (lightly less safe but faster,
better choice), 'adler32' (new choice, faster than crc32),
'strlen' for a length only test (fastest).
</entry>
</row>
<row>
<entry><emphasis>cache_file_umask</emphasis></entry>
<entry><type>Integer</type></entry>
<entry>0600</entry>
<entry>umask for cached files.</entry>
</row>
<row>
<entry><emphasis>cache_directory_umask</emphasis></entry>
<entry><type>Integer</type></entry>
<entry>0700</entry>
<entry>Umask for directories created within public_dir.</entry>
</row>
<row>
<entry><emphasis>file_extension</emphasis></entry>
<entry><type>String</type></entry>
<entry>'<filename>.html</filename>'</entry>
<entry>
Default file extension for static files created. This can be
configured on the fly, see
<methodname>Zend_Cache_Backend_Static::save()</methodname> though
generally it's recommended to rely on
<classname>Zend_Controller_Action_Helper_Cache</classname> when
doing so since it's simpler that way than messing with
arrays or serialization manually.
</entry>
</row>
<row>
<entry><emphasis>index_filename</emphasis></entry>
<entry><type>String</type></entry>
<entry>'index'</entry>
<entry>
If a request <acronym>URI</acronym> does not contain sufficient
information to construct a static file (usually this means an index
call, e.g. <acronym>URI</acronym> of '/'), the index_filename is used
instead. So '' or '/' would map to '<filename>index.html</filename>'
(assuming the default file_extension is '<filename>.html</filename>').
</entry>
</row>
<row>
<entry><emphasis>tag_cache</emphasis></entry>
<entry><type>Object</type></entry>
<entry><constant>NULL</constant></entry>
<entry>
Used to set an 'inner' cache utilised to store tags
and file extensions associated with static files. This
<emphasis>must</emphasis> be set or the static cache cannot be tracked
and managed.
</entry>
</row>
<row>
<entry><emphasis>disable_caching</emphasis></entry>
<entry><type>Boolean</type></entry>
<entry><constant>FALSE</constant></entry>
<entry>
If set to <constant>TRUE</constant>, static files will not be cached.
This will force all requests to be dynamic even if marked
to be cached in Controllers. Useful for debugging.
</entry>
</row>
</tbody>
</tgroup>
</table>
</sect2>
</sect1>
<!--
vim:se ts=4 sw=4 et:
-->
|
