Zend_Cache_Core は特別なフロントエンドであり、 モジュールのコアに含まれています。これはキャッシュフロントエンドの 基本機能を実装したものであり、他のクラスによってオーバーライドされます。

これらのオプションを、先の例で示したようにファクトリメソッドに渡します。

マニュアルのいちばんはじめのほうに、例を示しています。

もしキャッシュに文字列しか保存しないのなら ("automatic_serialization" オプションを使用すると boolean も保存できるので)、 このようにもう少しコンパクトに作成することが可能です。

// すでに $cache が存在するものとします

$id = 'myBigLoop'; //「キャッシュしたい内容」のキャッシュ ID

if ( ($data = $cache->load($id)) === false ) {
    // キャッシュが存在しませんでした

    $data = '';
    for ($i = 0; $i < 10000; $i++) {
        $data = $data . $i;
    }

    $cache->save($data);

}

// [...] $data を用いて何かをします (echo したり、何かに渡したりなど)

複数のブロックやデータのインスタンスをキャッシュしたい場合も、考え方は同じです。

// 一意な ID を使用するようにしましょう
$id1 = 'foo';
$id2 = 'bar';

// ブロック 1
if ( ($data = $cache->load($id1)) === false ) {
    // キャッシュが存在しませんでした

    $data = '';
    for ($i=0;$i<10000;$i++) {
        $data = $data . $i;
    }

    $cache->save($data);

}
echo($data);

// これは、キャッシュ処理の影響を受けません
echo('キャッシュされません !');

// ブロック 2
if ( ($data = $cache->load($id2)) === false ) {
    // キャッシュが存在しませんでした

    $data = '';
    for ($i=0;$i<10000;$i++) {
        $data = $data . '!';
    }

    $cache->save($data);

}
echo($data);

特殊な値 (boolean 値に "automatic_serialization" オプションを指定したものなど) や空の文字列をキャッシュしたい場合は、 上で示したコンパクトな例を使用することはできません。 キャッシュレコードを正式に調べる必要があります。

// コンパクトな構文
// (空の文字列や boolean をキャッシュする場合はうまくいきません)
if ( ($data = $cache->load($id)) === false ) {

    // キャッシュが存在しませんでした

    // [...] $data を作成します

    $cache->save($data);

}

// $data に対して何らかの操作をします

// [...]

// 完全な構文 (どんな場合でも動作します)
if (!($cache->test($id))) {

    // キャッシュが存在しませんでした

    // [...] $data を作成します

    $cache->save($data);

} else {

    // キャッシュが見つかりました

    $data = $cache->load($id);

}

// $data に対して何らかの操作をします

Zend_Cache_Frontend_Output は、出力を横取りするフロントエンドです。 これは PHP の出力バッファリング処理を使いやすくしたもので、 start() メソッドと end() メソッドの間の出力を横取りします。

Zend_Cache_Core のオプション以外に、 このフロントエンドが独自に使用するオプションはありません。

このマニュアルの冒頭に示した例とほとんど同じですが、少しだけ変更を加えています。

// キャッシュが見つからなかった場合に、出力バッファリングが起動します
if (!($cache->start('mypage'))) {

    // すべてをいつもどおりに出力しますoutput everything as usual
    echo 'Hello world! ';
    echo 'これはキャッシュされます ('.time().') ';

    $cache->end(); // 出力バッファリングを終了します

}

echo 'これはキャッシュされません ('.time().').';

この形式を使用すると、既存のプロジェクトに簡単に出力キャッシュ処理を追加できます。 コードのリファクタリングもほとんど行わずにすませられるでしょう。

Zend_Cache_Frontend_Function は、関数コールの結果をキャッシュします。 call() というメソッドを保持しており、 関数名とパラメータを配列にしてこのメソッドに渡します。

call() 関数の使用法は、PHP の call_user_func_array() と同じです。

$cache->call('veryExpensiveFunc', $params);

// $params は配列です。
// 例えば、veryExpensiveFunc(1, 'foo', 'bar') のコールをキャッシュするには
// $cache->call('veryExpensiveFunc', array(1, 'foo', 'bar')) とします。

Zend_Cache_Frontend_Function は、 関数の返り値だけでなく関数内部での出力もキャッシュします。

Zend_Cache_Frontend_Class は、Zend_Cache_Frontend_Function と異なり、オブジェクトおよびスタティックメソッドのコールをキャッシュします。

例えば、スタティックメソッドのコールをキャッシュするには次のようにします。

class Test {

    // スタティックメソッド
    public static function foobar($param1, $param2) {
        echo "foobar_output($param1, $param2)";
        return "foobar_return($param1, $param2)";
    }

}

// [...]
$frontendOptions = array(
    'cached_entity' => 'Test' // クラス名を指定します
);
// [...]

// これはキャッシュされます
$result = $cache->foobar('1', '2');

通常のメソッドのコールをキャッシュするには次のようにします。

class Test {

    private $_string = 'hello !';

    public function foobar2($param1, $param2) {
        echo($this->_string);
        echo "foobar2_output($param1, $param2)";
        return "foobar2_return($param1, $param2)";
    }

}

// [...]
$frontendOptions = array(
    'cached_entity' => new Test() // クラスのインスタンスを指定します
);
// [...]

// これはキャッシュされます
$result = $cache->foobar2('1', '2');

Zend_Cache_Frontend_File は、マスタファイルの 「更新時刻」にもとづいて動作するフロントエンドです。 これは、例えば設定ファイルやテンプレートなどで有効に使えるでしょう。 複数のマスタファイルを使用することもできます。

例えば、XML の設定ファイルを使用しており、それが「設定オブジェクト」 (Zend_Config など) を返す関数でパースされるとしましょう。 Zend_Cache_Frontend_File を使用すると、その「設定オブジェクト」 をキャッシュすることができ (これにより、 XML ファイルを毎回パースする必要がなくなります)、さらに「マスタファイル」 との間で強力な依存性を保持できます。そのため、XML 設定ファイルが更新されると、即時にキャッシュが無効になります。

このフロントエンドの使用法は Zend_Cache_Core と同じです。 そのため、特に例は用意していません。唯一しなければならないことは、 ファクトリを使用する際に、バックエンドのオプションとして master_file を設定することだけです。

Zend_Cache_Frontend_Page は Zend_Cache_Frontend_Output と似ていますが、ページ全体をキャッシュする目的で設計されています。 Zend_Cache_Frontend_Page を使用して、 ページの一部だけをキャッシュすることはできません。

一方、「キャッシュ ID」は自動的に生成されます。この ID は、 $_SERVER['REQUEST_URI'] および (オプションの設定によっては) $_GET、$_POST、$_SESSION、 $_COOKIE、$_FILES をもとにして生成されます。 さらに、ひとつのメソッド (start()) をコールするだけで使用できます。 end() は、ページの終了時に自動的にコールされます。

現時点ではまだ実装されていませんが、将来は HTTP conditional システムを追加する予定です。 これにより、ネットワークの帯域を節約できるようになります (キャッシュにヒットし、かつブラウザがそのバージョンを既に持っている場合に HTTP 304 Not Modified を送信するようにします)。

Zend_Cache_Frontend_Page の使用法は、きわめて簡単です。

// [...] // require、設定そしてファクトリ

$cache->start();
// キャッシュにヒットした場合はその結果がブラウザに送信され、
// 処理はここで停止します

// ページの残りの部分 ...

もう少し複雑な例を見てみましょう。これは、起動ファイル (例えば Zend_Controller など) 内でキャッシュを集中管理する方法を示したものです。

/*
 * キャッシュセクションの前には、あまり多くの行を書かないようにしましょう。
 * 例えば、処理速度を最適化するためには "require_once" や "Zend_Loader::loadClass"
 * をキャッシュセクションの後におくべきです。
 */

$frontendOptions = array(
   'lifetime' => 7200,
   'debug_header' => true, // デバッグします
   'regexps' => array(
       // IndexController 全体をキャッシュします
       '^/$' => array('cache' => true),

       // IndexController 全体をキャッシュします
       '^/index/' => array('cache' => true),

       // ArticleController はキャッシュしません
       '^/article/' => array('cache' => false),

       // ……が、ArticleController の "view" アクションはキャッシュします
       '^/article/view/' => array(
           'cache' => true,

           // また、たとえ $_POST に何らかの変数がふくまれていてもキャッシュを行います
           'cache_with_post_variables' => true,

           // しかし、そのキャッシュは $_POST 配列に依存します
           'make_id_with_post_variables' => true
       )
   )
);

$backendOptions = array(
    'cache_dir' => '/tmp/'
);

// Zend_Cache_Frontend_Page オブジェクトを取得します
$cache = Zend_Cache::factory('Page',
                             'File',
                             $frontendOptions,
                             $backendOptions);

$cache->start();
// キャッシュにヒットした場合はその結果がブラウザに送信され、スクリプトの処理はここで停止します。

// [...] 起動ファイルの終点 (これらの行は、キャッシュにヒットした場合は実行されません)

設計上の理由から、場合によっては (HTTP 200 以外のコードを使用する場合など) 現在のキャッシュ処理をキャンセルする必要が生じることもあります。 そこで、このフロントエンド用に cancel() メソッドを用意しました。

// [...] // require, configuration そして factory

$cache->start();

// [...]

if ($someTest) {
    $cache->cancel();
    // [...]
}

// [...]

Zend_Cache_Frontend_Capture is like Zend_Cache_Frontend_Output but designed for a complete page. It's impossible to use Zend_Cache_Frontend_Capture for caching only a single block. This class is specifically designed to operate in concert only with the Zend_Cache_Backend_Static backend to assist in caching entire pages of HTML / XML or other content to a physical static file on the local filesystem.

Please refer to the documentation on Zend_Cache_Backend_Static for all use cases pertaining to this class.