| blob | 3b9a4f5e1a109c749401207f7f01b8079f3cadd6 |
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!-- Reviewed: no -->
3 <!-- EN-Revision: 22140 -->
4 <sect1 id="zend.cache.frontends">
5 <title><classname>Zend_Cache</classname> のフロントエンド</title>
7 <sect2 id="zend.cache.frontends.core">
8 <title>Zend_Cache_Core</title>
9 <sect3 id="zend.cache.frontends.core.introduction">
10 <title>導入</title>
11 <para>
12 <classname>Zend_Cache_Core</classname> は特別なフロントエンドであり、
13 モジュールのコアに含まれています。これはキャッシュフロントエンドの
14 基本機能を実装したものであり、他のクラスによってオーバーライドされます。
15 </para>
16 <note><para>
17 その他のフロントエンドクラスは、すべて <classname>Zend_Cache_Core</classname>
18 を継承しており、以下で説明しているメソッドおよびオプションは
19 他のフロントエンドでも使用可能です。そのため、ここではこれらについての
20 詳しい説明は省略します。
21 </para></note>
22 </sect3>
23 <sect3 id="zend.cache.frontends.core.options">
24 <title>使用可能なオプション</title>
25 <para>
26 これらのオプションを、先の例で示したようにファクトリメソッドに渡します。
27 </para>
28 <table id="zend.cache.frontends.core.options.table">
29 <title>Core フロントエンドのオプション</title>
30 <tgroup cols="4">
31 <thead>
32 <row>
33 <entry>オプション</entry>
34 <entry>データ型</entry>
35 <entry>デフォルト値</entry>
36 <entry>説明</entry>
37 </row>
38 </thead>
39 <tbody>
40 <row>
41 <entry><emphasis>caching</emphasis></entry>
42 <entry><type>Boolean</type></entry>
43 <entry><constant>TRUE</constant></entry>
44 <entry>
45 キャッシングを有効/無効にします
46 (キャッシュされたスクリプトのデバッグ時に有用です)。
47 </entry>
48 </row>
49 <row>
50 <entry><emphasis>cache_id_prefix</emphasis></entry>
51 <entry><type>String</type></entry>
52 <entry><constant>NULL</constant></entry>
53 <entry>
54 すべてのキャッシュ ID のプレフィックス。<constant>NULL</constant> を指定すると、
55 プレフィックスは使用しません。
56 キャッシュ ID のプレフィックスは、いわばキャッシュ内での名前空間です。
57 これによって、複数のアプリケーションやウェブサイトで
58 キャッシュを共用できるようになります。
59 個々のアプリケーションやウェブサイトで
60 それぞれ異なるキャッシュ ID プレフィックスを用いるようにすれば、
61 特定のキャッシュ ID をそれぞれの環境で使用できるようになります。
62 </entry>
63 </row>
64 <row>
65 <entry><emphasis>lifetime</emphasis></entry>
66 <entry><type>Integer</type></entry>
67 <entry>3600</entry>
68 <entry>
69 キャッシュの有効期間 (秒)。<constant>NULL</constant>
70 を指定すると、有効期間が無期限となります。
71 </entry>
72 </row>
73 <row>
74 <entry><emphasis>logging</emphasis></entry>
75 <entry><type>Boolean</type></entry>
76 <entry><constant>FALSE</constant></entry>
77 <entry>
78 <constant>TRUE</constant> を指定すると、<classname>Zend_Log</classname> によるロギングが有効になります
79 (しかし、処理速度は低下します)。
80 </entry>
81 </row>
82 <row>
83 <entry><emphasis>write_control</emphasis></entry>
84 <entry><type>Boolean</type></entry>
85 <entry><constant>TRUE</constant></entry>
86 <entry>
87 書き込み制御を有効/無効にします (壊れたエントリを検出するため、
88 書き込んだ直後にそのキャッシュを読み込みます)。
89 writeControl を有効にすると、キャッシュの書き込みがやや遅くなりますが、
90 読み込みの速度は変わりません
91 (これはキャッシュファイルが壊れているかどうかを調べるものですが、
92 完全に判断できるわけではありません)。
93 </entry>
94 </row>
95 <row>
96 <entry><emphasis>automatic_serialization</emphasis></entry>
97 <entry><type>Boolean</type></entry>
98 <entry><constant>FALSE</constant></entry>
99 <entry>
100 自動シリアライズを有効/無効にします。
101 文字列でないデータを直接保存する際に使用します
102 (しかし、処理速度は低下します)。
103 </entry>
104 </row>
105 <row>
106 <entry><emphasis>automatic_cleaning_factor</emphasis></entry>
107 <entry><type>Integer</type></entry>
108 <entry>10</entry>
109 <entry>
110 自動クリーンアッププロセス (ガベージコレクタ) の設定を行います。
111 0 を指定すると、自動キャッシュクリーニングを行いません。
112 1 を指定すると計画的にキャッシュのクリーニングを行い、また
113 x (1 より大きな整数) を指定すると、
114 x 回のキャッシュ書き込みについて 1 回の頻度で
115 ランダムに自動クリーニングを行います。
116 </entry>
117 </row>
118 <row>
119 <entry><emphasis>ignore_user_abort</emphasis></entry>
120 <entry><type>Boolean</type></entry>
121 <entry><constant>FALSE</constant></entry>
122 <entry>
123 <constant>TRUE</constant> を指定すると、<methodname>save()</methodname> メソッド内で
124 <acronym>PHP</acronym> の ignore_user_abort フラグを設定し、
125 キャッシュが破壊されることを防ぎます。
126 </entry>
127 </row>
128 </tbody>
129 </tgroup>
130 </table>
131 </sect3>
133 <sect3 id="zend.cache.core.examples">
134 <title>例</title>
135 <para>
136 マニュアルのいちばんはじめのほうに、例を示しています。
137 </para>
138 <para>
139 もしキャッシュに文字列しか保存しないのなら
140 ("automatic_serialization" オプションを使用すると boolean も保存できるので)、
141 このようにもう少しコンパクトに作成することが可能です。
142 </para>
143 <programlisting language="php"><![CDATA[
144 // すでに $cache が存在するものとします
146 $id = 'myBigLoop'; //「キャッシュしたい内容」のキャッシュ ID
148 if (!($data = $cache->load($id))) {
149 // キャッシュが存在しませんでした
151 $data = '';
152 for ($i = 0; $i < 10000; $i++) {
153 $data = $data . $i;
154 }
156 $cache->save($data);
158 }
160 // [...] $data を用いて何かをします (echo したり、何かに渡したりなど)
161 ]]></programlisting>
162 <para>
163 複数のブロックやデータのインスタンスをキャッシュしたい場合も、考え方は同じです。
164 </para>
165 <programlisting language="php"><![CDATA[
166 // 一意な ID を使用するようにしましょう
167 $id1 = 'foo';
168 $id2 = 'bar';
170 // ブロック 1
171 if (!($data = $cache->load($id1))) {
172 // キャッシュが存在しませんでした
174 $data = '';
175 for ($i=0;$i<10000;$i++) {
176 $data = $data . $i;
177 }
179 $cache->save($data);
181 }
182 echo($data);
184 // これは、キャッシュ処理の影響を受けません
185 echo('キャッシュされません !');
187 // ブロック 2
188 if (!($data = $cache->load($id2))) {
189 // キャッシュが存在しませんでした
191 $data = '';
192 for ($i=0;$i<10000;$i++) {
193 $data = $data . '!';
194 }
196 $cache->save($data);
198 }
199 echo($data);
200 ]]></programlisting>
201 <para>
202 特殊な値 (boolean 値に "automatic_serialization" オプションを指定したものなど)
203 や空の文字列をキャッシュしたい場合は、
204 上で示したコンパクトな例を使用することはできません。
205 キャッシュレコードを正式に調べる必要があります。
206 </para>
207 <programlisting language="php"><![CDATA[
208 // コンパクトな構文
209 // (空の文字列や boolean をキャッシュする場合はうまくいきません)
210 if (!($data = $cache->load($id))) {
212 // キャッシュが存在しませんでした
214 // [...] $data を作成します
216 $cache->save($data);
218 }
220 // $data に対して何らかの操作をします
222 // [...]
224 // 完全な構文 (どんな場合でも動作します)
225 if (!($cache->test($id))) {
227 // キャッシュが存在しませんでした
229 // [...] $data を作成します
231 $cache->save($data);
233 } else {
235 // キャッシュが見つかりました
237 $data = $cache->load($id);
239 }
241 // $data に対して何らかの操作をします
242 ]]></programlisting>
243 </sect3>
244 </sect2>
246 <sect2 id="zend.cache.frontends.output">
247 <title>Zend_Cache_Frontend_Output</title>
248 <sect3 id="zend.cache.frontends.output.introduction">
249 <title>導入</title>
250 <para>
251 <classname>Zend_Cache_Frontend_Output</classname> は、出力を横取りするフロントエンドです。
252 これは <acronym>PHP</acronym> の出力バッファリング処理を使いやすくしたもので、
253 <methodname>start()</methodname> メソッドと
254 <methodname>end()</methodname> メソッドの間の出力を横取りします。
255 </para>
256 </sect3>
257 <sect3 id="zend.cache.frontends.output.options">
258 <title>使用可能なオプション</title>
259 <para>
260 <classname>Zend_Cache_Core</classname> のオプション以外に、
261 このフロントエンドが独自に使用するオプションはありません。
262 </para>
263 </sect3>
265 <sect3 id="zend.cache.frontends.output.examples">
266 <title>例</title>
267 <para>
268 このマニュアルの冒頭に示した例とほとんど同じですが、少しだけ変更を加えています。
269 </para>
270 <programlisting language="php"><![CDATA[
271 // キャッシュが見つからなかった場合に、出力バッファリングが起動します
272 if (!($cache->start('mypage'))) {
274 // すべてをいつもどおりに出力しますoutput everything as usual
275 echo 'Hello world! ';
276 echo 'これはキャッシュされます ('.time().') ';
278 $cache->end(); // 出力バッファリングを終了します
280 }
282 echo 'これはキャッシュされません ('.time().').';
283 ]]></programlisting>
284 <para>
285 この形式を使用すると、既存のプロジェクトに簡単に出力キャッシュ処理を追加できます。
286 コードのリファクタリングもほとんど行わずにすませられるでしょう。
287 </para>
288 </sect3>
289 </sect2>
291 <sect2 id="zend.cache.frontends.function">
292 <title>Zend_Cache_Frontend_Function</title>
293 <sect3 id="zend.cache.frontends.function.introduction">
294 <title>導入</title>
295 <para>
296 <classname>Zend_Cache_Frontend_Function</classname> は、関数コールの結果をキャッシュします。
297 <methodname>call()</methodname> というメソッドを保持しており、
298 関数名とパラメータを配列にしてこのメソッドに渡します。
299 </para>
300 </sect3>
301 <sect3 id="zend.cache.frontends.function.options">
302 <title>使用可能なオプション</title>
303 <table id="zend.cache.frontends.function.options.table">
304 <title>Function フロントエンドのオプション</title>
305 <tgroup cols="4">
306 <thead>
307 <row>
308 <entry>オプション</entry>
309 <entry>データ型</entry>
310 <entry>デフォルト値</entry>
311 <entry>説明</entry>
312 </row>
313 </thead>
314 <tbody>
315 <row>
316 <entry><emphasis>cache_by_default</emphasis></entry>
317 <entry><type>Boolean</type></entry>
318 <entry><constant>TRUE</constant></entry>
319 <entry>
320 <constant>TRUE</constant> の場合は、関数のコール結果がデフォルトでキャッシュされます。
321 </entry>
322 </row>
323 <row>
324 <entry><emphasis>cached_functions</emphasis></entry>
325 <entry><type>Array</type></entry>
326 <entry></entry>
327 <entry>
328 常にキャッシュされる関数の名前。
329 </entry>
330 </row>
331 <row>
332 <entry><emphasis>non_cached_functions</emphasis></entry>
333 <entry><type>Array</type></entry>
334 <entry></entry>
335 <entry>
336 決してキャッシュされない関数の名前。
337 </entry>
338 </row>
339 </tbody>
340 </tgroup>
341 </table>
342 </sect3>
344 <sect3 id="zend.cache.frontends.function.examples">
345 <title>例</title>
346 <para>
347 <methodname>call()</methodname> 関数の使用法は、<acronym>PHP</acronym> の
348 <methodname>call_user_func_array()</methodname> と同じです。
349 </para>
350 <programlisting language="php"><![CDATA[
351 $cache->call('veryExpensiveFunc', $params);
353 // $params は配列です。
354 // 例えば、veryExpensiveFunc(1, 'foo', 'bar') のコールをキャッシュするには
355 // $cache->call('veryExpensiveFunc', array(1, 'foo', 'bar')) とします。
356 ]]></programlisting>
357 <para>
358 <classname>Zend_Cache_Frontend_Function</classname> は、
359 関数の返り値だけでなく関数内部での出力もキャッシュします。
360 </para>
361 <note><para>
362 <methodname>array()</methodname>、<methodname>echo()</methodname>、<methodname>empty()</methodname>、<methodname>eval()</methodname>、
363 <methodname>exit()</methodname>、<methodname>isset()</methodname>、<methodname>list()</methodname>、<methodname>print()</methodname>
364 および <methodname>unset()</methodname> 以外なら、
365 任意の組み込み関数やユーザ定義関数を渡すことができます。
366 </para></note>
367 </sect3>
368 </sect2>
370 <sect2 id="zend.cache.frontends.class">
371 <title>Zend_Cache_Frontend_Class</title>
372 <sect3 id="zend.cache.frontends.class.introduction">
373 <title>導入</title>
374 <para>
375 <classname>Zend_Cache_Frontend_Class</classname> は、<classname>Zend_Cache_Frontend_Function</classname>
376 と異なり、オブジェクトおよびスタティックメソッドのコールをキャッシュします。
377 </para>
378 </sect3>
379 <sect3 id="zend.cache.frontends.class.options">
380 <title>使用可能なオプション</title>
381 <table id="zend.cache.frontends.class.options.table">
382 <title>Class フロントエンドのオプション</title>
383 <tgroup cols="4">
384 <thead>
385 <row>
386 <entry>オプション</entry>
387 <entry>データ型</entry>
388 <entry>デフォルト値</entry>
389 <entry>説明</entry>
390 </row>
391 </thead>
392 <tbody>
393 <row>
394 <entry><emphasis>cached_entity</emphasis> (必須)</entry>
395 <entry><type>Mixed</type></entry>
396 <entry></entry>
397 <entry>
398 クラス名を設定すると、抽象クラスおよびスタティックコールをキャッシュします。
399 オブジェクトを設定すると、そのオブジェクトのメソッドをキャッシュします。
400 </entry>
401 </row>
402 <row>
403 <entry><emphasis>cache_by_default</emphasis></entry>
404 <entry><type>Boolean</type></entry>
405 <entry><constant>TRUE</constant></entry>
406 <entry>
407 <constant>TRUE</constant> を設定すると、デフォルトでキャッシュされます。
408 </entry>
409 </row>
410 <row>
411 <entry><emphasis>cached_methods</emphasis></entry>
412 <entry><type>Array</type></entry>
413 <entry></entry>
414 <entry>
415 常にキャッシュされるメソッドの名前。
416 </entry>
417 </row>
418 <row>
419 <entry><emphasis>non_cached_methods</emphasis></entry>
420 <entry><type>Array</type></entry>
421 <entry></entry>
422 <entry>
423 決してキャッシュされないメソッドの名前。
424 </entry>
425 </row>
426 </tbody>
427 </tgroup>
428 </table>
429 </sect3>
431 <sect3 id="zend.cache.frontends.class.examples">
432 <title>例</title>
433 <para>
434 例えば、スタティックメソッドのコールをキャッシュするには次のようにします。
435 </para>
436 <programlisting language="php"><![CDATA[
437 class Test {
439 // スタティックメソッド
440 public static function foobar($param1, $param2) {
441 echo "foobar_output($param1, $param2)";
442 return "foobar_return($param1, $param2)";
443 }
445 }
447 // [...]
448 $frontendOptions = array(
449 'cached_entity' => 'Test' // クラス名を指定します
450 );
451 // [...]
453 // これはキャッシュされます
454 $result = $cache->foobar('1', '2');
455 ]]></programlisting>
456 <para>
457 通常のメソッドのコールをキャッシュするには次のようにします。
458 </para>
459 <programlisting language="php"><![CDATA[
460 class Test {
462 private $_string = 'hello !';
464 public function foobar2($param1, $param2) {
465 echo($this->_string);
466 echo "foobar2_output($param1, $param2)";
467 return "foobar2_return($param1, $param2)";
468 }
470 }
472 // [...]
473 $frontendOptions = array(
474 'cached_entity' => new Test() // クラスのインスタンスを指定します
475 );
476 // [...]
478 // これはキャッシュされます
479 $result = $cache->foobar2('1', '2');
480 ]]></programlisting>
481 </sect3>
482 </sect2>
484 <sect2 id="zend.cache.frontends.file">
485 <title>Zend_Cache_Frontend_File</title>
486 <sect3 id="zend.cache.frontends.file.introduction">
487 <title>導入</title>
488 <para>
489 <classname>Zend_Cache_Frontend_File</classname> は、マスタファイルの
490 「更新時刻」にもとづいて動作するフロントエンドです。
491 これは、例えば設定ファイルやテンプレートなどで有効に使えるでしょう。
492 複数のマスタファイルを使用することもできます。
493 </para>
494 <para>
495 例えば、<acronym>XML</acronym> の設定ファイルを使用しており、それが「設定オブジェクト」
496 (<classname>Zend_Config</classname> など) を返す関数でパースされるとしましょう。
497 <classname>Zend_Cache_Frontend_File</classname> を使用すると、その「設定オブジェクト」
498 をキャッシュすることができ (これにより、
499 <acronym>XML</acronym> ファイルを毎回パースする必要がなくなります)、さらに「マスタファイル」
500 との間で強力な依存性を保持できます。そのため、<acronym>XML</acronym>
501 設定ファイルが更新されると、即時にキャッシュが無効になります。
502 </para>
503 </sect3>
504 <sect3 id="zend.cache.frontends.file.options">
505 <title>使用可能なオプション</title>
506 <table id="zend.cache.frontends.file.options.table">
507 <title>File フロントエンドのオプション</title>
508 <tgroup cols="4">
509 <thead>
510 <row>
511 <entry>オプション</entry>
512 <entry>データ型</entry>
513 <entry>デフォルト値</entry>
514 <entry>説明</entry>
515 </row>
516 </thead>
517 <tbody>
518 <row>
519 <entry><emphasis>master_file (非推奨)</emphasis></entry>
520 <entry><type>String</type></entry>
521 <entry>''</entry>
522 <entry>
523 マスタファイルへのフルパス。
524 </entry>
525 </row>
526 <row>
527 <entry><emphasis>master_files</emphasis></entry>
528 <entry><type>Array</type></entry>
529 <entry><methodname>array()</methodname></entry>
530 <entry>
531 マスタファイル群へのフルパスの配列。
532 </entry>
533 </row>
534 <row>
535 <entry><emphasis>master_files_mode</emphasis></entry>
536 <entry><type>String</type></entry>
537 <entry><constant>Zend_Cache_Frontend_File::MODE_OR</constant></entry>
538 <entry>
539 <constant>Zend_Cache_Frontend_File::MODE_AND</constant> あるいは
540 <constant>Zend_Cache_Frontend_File::MODE_OR</constant>。
541 <constant>MODE_AND</constant> の場合は、
542 すべてのマスタファイルにアクセスがあるまでキャッシュが無効化されません。
543 <constant>MODE_OR</constant> の場合は、
544 どれかひとつのマスタファイルにアクセスがあればキャッシュを無効化します。
545 </entry>
546 </row>
547 <row>
548 <entry><emphasis>ignore_missing_master_files</emphasis></entry>
549 <entry><type>Boolean</type></entry>
550 <entry><constant>FALSE</constant></entry>
551 <entry>
552 <constant>TRUE</constant> の場合は、マスタファイルが存在しない場合は無視します
553 (それ以外の場合は例外が発生します)。
554 </entry>
555 </row>
556 </tbody>
557 </tgroup>
558 </table>
559 </sect3>
560 <sect3 id="zend.cache.frontends.file.examples">
561 <title>例</title>
562 <para>
563 このフロントエンドの使用法は <classname>Zend_Cache_Core</classname> と同じです。
564 そのため、特に例は用意していません。唯一しなければならないことは、
565 ファクトリを使用する際に、バックエンドのオプションとして
566 <emphasis>master_file</emphasis> を設定することだけです。
567 </para>
568 </sect3>
569 </sect2>
571 <sect2 id="zend.cache.frontends.page">
572 <title>Zend_Cache_Frontend_Page</title>
573 <sect3 id="zend.cache.frontends.page.introduction">
574 <title>導入</title>
575 <para>
576 <classname>Zend_Cache_Frontend_Page</classname> は <classname>Zend_Cache_Frontend_Output</classname>
577 と似ていますが、ページ全体をキャッシュする目的で設計されています。
578 <classname>Zend_Cache_Frontend_Page</classname> を使用して、
579 ページの一部だけをキャッシュすることはできません。
580 </para>
581 <para>
582 一方、「キャッシュ ID」は自動的に生成されます。この ID は、
583 <varname>$_SERVER['REQUEST_URI']</varname> および (オプションの設定によっては)
584 <varname>$_GET</varname>、<varname>$_POST</varname>、<varname>$_SESSION</varname>、
585 <varname>$_COOKIE</varname>、<varname>$_FILES</varname> をもとにして生成されます。
586 さらに、ひとつのメソッド (<methodname>start()</methodname>) をコールするだけで使用できます。
587 <methodname>end()</methodname> は、ページの終了時に自動的にコールされます。
588 </para>
589 <para>
590 現時点ではまだ実装されていませんが、将来は <acronym>HTTP</acronym> conditional システムを追加する予定です。
591 これにより、ネットワークの帯域を節約できるようになります
592 (キャッシュにヒットし、かつブラウザがそのバージョンを既に持っている場合に
593 <acronym>HTTP</acronym> 304 Not Modified を送信するようにします)。
594 </para>
595 <!-- TODO : to be translated -->
596 <note>
597 <para>
598 This frontend operates by registering a callback function to be called
599 when the output buffering it uses is cleaned. In order for this to operate
600 correctly, it must be the final output buffer in the request. To guarantee
601 this, the output buffering used by the Dispatcher <emphasis>must</emphasis> be
602 disabled by calling <classname>Zend_Controller_Front</classname>'s
603 <methodname>setParam()</methodname> method, for example,
604 <command>$front->setParam('disableOutputBuffering', true);</command> or adding
605 "resources.frontcontroller.params.disableOutputBuffering = true"
606 to your bootstrap configuration file (assumed <acronym>INI</acronym>) if using
607 <classname>Zend_Application</classname>.
608 </para>
609 </note>
610 </sect3>
611 <sect3 id="zend.cache.frontends.page.options">
612 <title>使用可能なオプション</title>
613 <table id="zend.cache.frontends.page.options.table">
614 <title>Page フロントエンドのオプション</title>
615 <tgroup cols="4">
616 <thead>
617 <row>
618 <entry>オプション</entry>
619 <entry>データ型</entry>
620 <entry>デフォルト値</entry>
621 <entry>説明</entry>
622 </row>
623 </thead>
624 <tbody>
625 <row>
626 <entry><emphasis>http_conditional</emphasis></entry>
627 <entry><type>Boolean</type></entry>
628 <entry><constant>FALSE</constant></entry>
629 <entry>
630 http_conditional システムを使用します (現時点ではまだ実装されていません)。
631 </entry>
632 </row>
633 <row>
634 <entry><emphasis>debug_header</emphasis></entry>
635 <entry><type>Boolean</type></entry>
636 <entry><constant>FALSE</constant></entry>
637 <entry>
638 <constant>TRUE</constant> の場合は、キャッシュされた各ページの先頭に
639 デバッグ用テキストが追加されます。
640 </entry>
641 </row>
642 <row>
643 <entry><emphasis>default_options</emphasis></entry>
644 <entry><type>Array</type></entry>
645 <entry><methodname>array(...説明を参照ください...)</methodname></entry>
646 <entry>
647 デフォルトのオプションを表す連想配列です。
648 <itemizedlist>
649 <listitem>
650 <para>
651 <emphasis>(boolean, デフォルトは <constant>TRUE</constant>) cache</emphasis> :
652 <constant>TRUE</constant> の場合はキャッシュが有効になります。
653 </para>
654 </listitem>
655 <listitem>
656 <para>
657 <emphasis>(boolean, デフォルトは <constant>FALSE</constant>) cache_with_get_variables</emphasis> :
658 <constant>TRUE</constant> の場合は、<varname>$_GET</varname> 配列に変数が含まれていてもキャッシュがオンのままになります。
659 </para>
660 </listitem>
661 <listitem>
662 <para>
663 <emphasis>(boolean, デフォルトは <constant>FALSE</constant>) cache_with_post_variables</emphasis> :
664 <constant>TRUE</constant> の場合は、<varname>$_POST</varname> 配列に変数が含まれていてもキャッシュがオンのままになります。
665 </para>
666 </listitem>
667 <listitem>
668 <para>
669 <emphasis>(boolean, デフォルトは <constant>FALSE</constant>) cache_with_session_variables</emphasis> :
670 <constant>TRUE</constant> の場合は、<varname>$_SESSION</varname> 配列に変数が含まれていてもキャッシュがオンのままになります。
671 </para>
672 </listitem>
673 <listitem>
674 <para>
675 <emphasis>(boolean, デフォルトは <constant>FALSE</constant>) cache_with_files_variables</emphasis> :
676 <constant>TRUE</constant> の場合は、<varname>$_FILES</varname> 配列に変数が含まれていてもキャッシュがオンのままになります。
677 </para>
678 </listitem>
679 <listitem>
680 <para>
681 <emphasis>(boolean, デフォルトは <constant>FALSE</constant>) cache_with_cookie_variables</emphasis> :
682 <constant>TRUE</constant> の場合は、<varname>$_COOKIE</varname> 配列に変数が含まれていてもキャッシュがオンのままになります。
683 </para>
684 </listitem>
685 <listitem>
686 <para>
687 <emphasis>(boolean, デフォルトは <constant>TRUE</constant>) make_id_with_get_variables</emphasis> :
688 <constant>TRUE</constant> の場合は、キャッシュ ID が <varname>$_GET</varname> 配列の内容に依存するようになります。
689 </para>
690 </listitem>
691 <listitem>
692 <para>
693 <emphasis>(boolean, デフォルトは <constant>TRUE</constant>) make_id_with_post_variables</emphasis> :
694 <constant>TRUE</constant> の場合は、キャッシュ ID が <varname>$_POST</varname> 配列の内容に依存するようになります。
695 </para>
696 </listitem>
697 <listitem>
698 <para>
699 <emphasis>(boolean, デフォルトは <constant>TRUE</constant>) make_id_with_session_variables</emphasis> :
700 <constant>TRUE</constant> の場合は、キャッシュ ID が <varname>$_SESSION</varname> 配列の内容に依存するようになります。
701 </para>
702 </listitem>
703 <listitem>
704 <para>
705 <emphasis>(boolean, デフォルトは <constant>TRUE</constant>) make_id_with_files_variables</emphasis> :
706 <constant>TRUE</constant> の場合は、キャッシュ ID が <varname>$_FILES</varname> 配列の内容に依存するようになります。
707 </para>
708 </listitem>
709 <listitem>
710 <para>
711 <emphasis>(boolean, デフォルトは <constant>TRUE</constant>) make_id_with_cookie_variables</emphasis> :
712 <constant>TRUE</constant> の場合は、キャッシュ ID が <varname>$_COOKIE</varname> 配列の内容に依存するようになります。
713 </para>
714 </listitem>
715 <listitem>
716 <para>
717 <emphasis>(int, デフォルトは <constant>FALSE</constant>) specific_lifetime</emphasis> :
718 <constant>FALSE</constant> でない場合は、選択した正規表現に対して指定した有効期限を使用します。
719 </para>
720 </listitem>
721 <listitem>
722 <para>
723 <emphasis>(配列, デフォルトは <methodname>array()</methodname>) tags</emphasis> :
724 キャッシュレコード用のタグ。
725 </para>
726 </listitem>
727 <listitem>
728 <para>
729 <emphasis>(int, デフォルトは <constant>NULL</constant>) priority</emphasis> :
730 優先度 (バックエンドが優先度をサポートしている場合)。
731 </para>
732 </listitem>
733 </itemizedlist>
734 </entry>
735 </row>
736 <row>
737 <entry><emphasis>regexps</emphasis></entry>
738 <entry><type>Array</type></entry>
739 <entry><methodname>array()</methodname></entry>
740 <entry>
741 特定の <constant>REQUEST_URI</constant> に対してのみ適用するオプションを設定する連想配列です。
742 キーが (<acronym>PCRE</acronym> の) 正規表現、対応する値は連想配列となります。
743 この連想配列には、正規表現が <varname>$_SERVER['REQUEST_URI']</varname>
744 にマッチした場合に設定されるオプションを設定します
745 (使用可能なオプションについては default_options を参照ください)。
746 複数の正規表現が <varname>$_SERVER['REQUEST_URI']</varname> にマッチした場合は、
747 一番最後にマッチしたもののみが使用されます。
748 </entry>
749 </row>
750 <row>
751 <entry><emphasis>memorize_headers</emphasis></entry>
752 <entry><type>Array</type></entry>
753 <entry><methodname>array()</methodname></entry>
754 <entry>
755 <acronym>HTTP</acronym> ヘッダ名に対応する文字列の配列です。
756 ここにあげられたヘッダがキャッシュデータとともに保存され、
757 キャッシュにヒットしたときにそれが "リプレイ" されます。
758 </entry>
759 </row>
760 </tbody>
761 </tgroup>
762 </table>
763 </sect3>
764 <sect3 id="zend.cache.frontends.page.examples">
765 <title>例</title>
766 <para>
767 <classname>Zend_Cache_Frontend_Page</classname> の使用法は、きわめて簡単です。
768 </para>
769 <programlisting language="php"><![CDATA[
770 // [...] // require、設定そしてファクトリ
772 $cache->start();
773 // キャッシュにヒットした場合はその結果がブラウザに送信され、
774 // 処理はここで停止します
776 // ページの残りの部分 ...
777 ]]></programlisting>
778 <para>
779 もう少し複雑な例を見てみましょう。これは、起動ファイル
780 (例えば <classname>Zend_Controller</classname> など) 内でキャッシュを集中管理する方法を示したものです。
781 </para>
782 <programlisting language="php"><![CDATA[
783 /*
784 * キャッシュセクションの前には、あまり多くの行を書かないようにしましょう。
785 * 例えば、処理速度を最適化するためには "require_once" や "Zend_Loader::loadClass"
786 * をキャッシュセクションの後におくべきです。
787 */
789 $frontendOptions = array(
790 'lifetime' => 7200,
791 'debug_header' => true, // デバッグします
792 'regexps' => array(
793 // IndexController 全体をキャッシュします
794 '^/$' => array('cache' => true),
796 // IndexController 全体をキャッシュします
797 '^/index/' => array('cache' => true),
799 // ArticleController はキャッシュしません
800 '^/article/' => array('cache' => false),
802 // ……が、ArticleController の "view" アクションはキャッシュします
803 '^/article/view/' => array(
804 'cache' => true,
806 // また、たとえ $_POST に何らかの変数がふくまれていてもキャッシュを行います
807 'cache_with_post_variables' => true,
809 // しかし、そのキャッシュは $_POST 配列に依存します
810 'make_id_with_post_variables' => true
811 )
812 )
813 );
815 $backendOptions = array(
816 'cache_dir' => '/tmp/'
817 );
819 // Zend_Cache_Frontend_Page オブジェクトを取得します
820 $cache = Zend_Cache::factory('Page',
821 'File',
822 $frontendOptions,
823 $backendOptions);
825 $cache->start();
826 // キャッシュにヒットした場合はその結果がブラウザに送信され、スクリプトの処理はここで停止します。
828 // [...] 起動ファイルの終点 (これらの行は、キャッシュにヒットした場合は実行されません)
829 ]]></programlisting>
830 </sect3>
831 <sect3 id="zend.cache.frontends.page.cancel">
832 <title>キャンセル用のメソッド</title>
833 <para>
834 設計上の理由から、場合によっては (<acronym>HTTP</acronym> 200 以外のコードを使用する場合など)
835 現在のキャッシュ処理をキャンセルする必要が生じることもあります。
836 そこで、このフロントエンド用に <methodname>cancel()</methodname> メソッドを用意しました。
837 </para>
838 <programlisting language="php"><![CDATA[
839 // [...] // require, configuration そして factory
841 $cache->start();
843 // [...]
845 if ($someTest) {
846 $cache->cancel();
847 // [...]
848 }
850 // [...]
851 ]]></programlisting>
852 </sect3>
853 </sect2>
855 <sect2 id="zend.cache.frontends.capture">
856 <title>Zend_Cache_Frontend_Capture</title>
858 <sect3 id="zend.cache.frontends.capture.introduction">
859 <title>Introduction</title>
861 <para>
862 <classname>Zend_Cache_Frontend_Capture</classname> is like
863 <classname>Zend_Cache_Frontend_Output</classname> but designed for a complete page.
864 It's impossible to use <classname>Zend_Cache_Frontend_Capture</classname> for
865 caching only a single block. This class is specifically designed to operate in
866 concert only with the <classname>Zend_Cache_Backend_Static</classname> backend to
867 assist in caching entire pages of <acronym>HTML</acronym> / <acronym>XML</acronym>
868 or other content to a physical static file on the local filesystem.
869 </para>
871 <para>
872 Please refer to the documentation on
873 <classname>Zend_Cache_Backend_Static</classname> for all use cases pertaining to
874 this class.
875 </para>
877 <note>
878 <para>
879 This frontend operates by registering a callback function to be called
880 when the output buffering it uses is cleaned. In order for this to operate
881 correctly, it must be the final output buffer in the request. To guarantee
882 this, the output buffering used by the Dispatcher <emphasis>must</emphasis> be
883 disabled by calling <classname>Zend_Controller_Front</classname>'s
884 <methodname>setParam()</methodname> method, for example,
885 <command>$front->setParam('disableOutputBuffering', true);</command> or adding
886 "resources.frontcontroller.params.disableOutputBuffering = true"
887 to your bootstrap configuration file (assumed <acronym>INI</acronym>) if using
888 <classname>Zend_Application</classname>.
889 </para>
890 </note>
891 </sect3>
892 </sect2>
893 </sect1>
894 <!--
895 vim:se ts=4 sw=4 et:
896 -->