documentation/manual/ja/module_specs/Zend_Cache-Theory.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <!-- EN-Revision: 21109 -->
   4 <sect1 id="zend.cache.theory">
   5     <title>キャッシュの仕組み</title>
   6
   7     <para>
   8         <classname>Zend_Cache</classname> には、3 つのポイントがあります。まず最初は一意な ID (文字列) で、
   9         これによってキャッシュレコードを識別します。二番目は、例に含まれる
  10         <emphasis>'lifetime'</emphasis> ディレクティブです。これは、キャッシュされたリソースの
  11         「賞味期限」を定義するものです。三番目のポイントとなるのが条件付きの実行処理で、
  12         不要なコードを完全に読み飛ばすことで処理速度を向上させることになります。
  13         フロントエンドの主となる関数 (例えば <methodname>Zend_Cache_Core::get()</methodname>)
  14         は、キャッシュがヒットしなかった場合には常に <constant>FALSE</constant> を返すよう設計されています。
  15         そのため、キャッシュしたい (そして読み飛ばしたい) 部分を
  16         <emphasis><methodname>if()</methodname>{ ... }</emphasis> 文で囲む際に、
  17         条件式として <classname>Zend_Cache</classname>
  18         のメソッド自身を使用できるようになっています。
  19         このブロックの最後では、出力内容を
  20         (例えば <methodname>Zend_Cache_Core::save()</methodname> などで)
  21         保存する必要があります。
  22     </para>
  23
  24     <note>
  25         <para>
  26             条件付きの実行処理を必ず記述しなければならないわけではありません。
  27             フロントエンドの種類によっては (例えば <emphasis>Function</emphasis> など)、
  28             すべてのロジックがフロントエンドの中で実装されています。
  29         </para>
  30     </note>
  31
  32     <note>
  33         <para>
  34             'Cache hit (キャッシュにヒットした)' とは、キャッシュレコードが見つかり、
  35             かつそのレコードが 'fresh (新鮮)' (言い換えると、まだ有効期限が切れていない)
  36             状態であることを表す言葉です。'Cache miss (キャッシュが見つからなかった)'
  37             はその正反対です。キャッシュが見つからなかった場合は、
  38             データを (通常どおりに) 作成し、それをキャッシュしなければなりません。
  39             一方、キャッシュにヒットした場合は、
  40             バックエンドが自動的にキャッシュレコードを取得してくれます。
  41         </para>
  42     </note>
  43
  44     <sect2 id="zend.cache.factory">
  45         <title>Zend_Cache ファクトリメソッド</title>
  46
  47         <para>
  48             使用可能な <classname>Zend_Cache</classname> フロントエンドのインスタンスを作成する方法を、
  49             以下の例で示します。
  50         </para>
  51
  52         <programlisting language="php"><![CDATA[
  53 // バックエンドを選びます (例えば 'File' や 'Sqlite'...)
  54 $backendName = '[...]';
  55
  56 // フロントエンドを選びます (例えば 'Core'、'Output'、'Page'...)
  57 $frontendName = '[...]';
  58
  59 // 選択したフロントエンド用のオプションを配列に設定します
  60 $frontendOptions = array([...]);
  61
  62 // 選択したバックエンド用のオプションを配列に設定します
  63 $backendOptions = array([...]);
  64
  65 // インスタンスを作成します
  66 // (もちろん、最後の 2 つの引数は必須ではありません)
  67 $cache = Zend_Cache::factory($frontendName,
  68                              $backendName,
  69                              $frontendOptions,
  70                              $backendOptions);
  71 ]]></programlisting>
  72
  73          <para>
  74             これ以降のドキュメントでは、<varname>$cache</varname>
  75             の中身が有効なフロントエンドになっているものとします。また、
  76             選択したバックエンドにパラメータを渡す方法は理解できているものとします。
  77         </para>
  78
  79         <note>
  80             <para>
  81                 常に <methodname>Zend_Cache::factory()</methodname> を使用してフロントエンドの
  82                 インスタンスを作成するようにしてください。フロントエンドやバックエンドを
  83                 自前で作成しようとしても、期待通りには動作しないでしょう。
  84             </para>
  85         </note>
  86     </sect2>
  87
  88     <sect2 id="zend.cache.tags">
  89         <title>レコードのタグ付け</title>
  90
  91         <para>
  92             タグは、キャッシュレコードを分類するための仕組みです。
  93             <methodname>save()</methodname> メソッドでキャッシュを保存する際に、
  94             適用するタグを配列で指定できます。これを使用すると、
  95             指定したタグが設定されているキャッシュレコードのみを削除するといったことが可能となります。
  96         </para>
  97
  98         <programlisting language="php"><![CDATA[
  99 $cache->save($huge_data, 'myUniqueID', array('tagA', 'tagB', 'tagC'));
 100 ]]></programlisting>
 101
 102         <note>
 103             <para>
 104                 <methodname>save()</methodname> メソッドには、オプションの第四引数
 105                 <varname>$specificLifetime</varname> を指定できることに注意しましょう
 106                 (<constant>FALSE</constant> 以外を指定することで、このキャッシュレコードの有効期限を特定の値に設定できます)。
 107             </para>
 108         </note>
 109     </sect2>
 110
 111     <sect2 id="zend.cache.clean">
 112         <title>キャッシュの削除</title>
 113
 114         <para>
 115             特定のキャッシュ ID を削除/無効化するには、<methodname>remove()</methodname>
 116             メソッドを使用します。
 117         </para>
 118
 119         <programlisting language="php"><![CDATA[
 120 $cache->remove('削除するID');
 121 ]]></programlisting>
 122
 123         <para>
 124             一回の操作で複数のキャッシュ ID を削除/無効化するには、<methodname>clean()</methodname>
 125             メソッドを使用します。例えば、すべてのキャッシュレコードを削除するには次のようにします。
 126         </para>
 127
 128         <programlisting language="php"><![CDATA[// すべてのレコードを削除します
 129 $cache->clean(Zend_Cache::CLEANING_MODE_ALL);
 130
 131 // 有効期限切れのレコードのみ削除します
 132 $cache->clean(Zend_Cache::CLEANING_MODE_OLD);
 133 ]]></programlisting>
 134
 135         <para>
 136             タグ 'tagA' および 'tagC' に該当するキャッシュエントリを削除するには、このようにします。
 137         </para>
 138
 139         <programlisting language="php"><![CDATA[
 140 $cache->clean(
 141     Zend_Cache::CLEANING_MODE_MATCHING_TAG,
 142     array('tagA', 'tagC')
 143 );
 144 ]]></programlisting>
 145
 146         <para>
 147             タグ 'tagA' にも 'tagC' にも該当しないキャッシュエントリを削除するには、このようにします。
 148         </para>
 149
 150         <programlisting language="php"><![CDATA[
 151 $cache->clean(
 152     Zend_Cache::CLEANING_MODE_NOT_MATCHING_TAG,
 153     array('tagA', 'tagC')
 154 );
 155 ]]></programlisting>
 156
 157         <para>
 158             タグ 'tagA' または 'tagC' に該当するキャッシュエントリを削除するには、このようにします。
 159         </para>
 160
 161         <programlisting language="php"><![CDATA[
 162 $cache->clean(
 163     Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG,
 164     array('tagA', 'tagC')
 165 );
 166 ]]></programlisting>
 167
 168         <para>
 169             削除モードとして指定可能な値は <constant>CLEANING_MODE_ALL</constant>、<constant>CLEANING_MODE_OLD</constant>、
 170             <constant>CLEANING_MODE_MATCHING_TAG</constant>、<constant>CLEANING_MODE_NOT_MATCHING_TAG</constant> および
 171             <constant>CLEANING_MODE_MATCHING_ANY_TAG</constant> です。
 172             後者は、その名が示すとおり、タグの配列と組み合わせて使用します。
 173         </para>
 174     </sect2>
 175 </sect1>
 176 <!--
 177 vim:se ts=4 sw=4 et:
 178 -->