Old/Zend Performance Suite/API

モニタリングAPI

accelerator_get_statistics

mixed accelerator_get_statistics()

コード高速化の統計情報で表示される情報を PHP 配列としてリターンします。

accelerator_get_scripts

mixed accelerator_get_scripts()

メモリ内に格納されている コード高速化対象のスクリプトに関する情報の内容を PHP の配列としてリターンします。

accelerator_get_compress_blacklisted_paths

mixed accelerator_get_compress_blacklisted_paths()

ブラックリスト内の圧縮されたコンテンツを PHP 配列としてリターンします。

accelerator_get_configuration

mixed accelerator_get_configuration()

Zend Performance Suite 構成に関する情報の内容をPHP 配列としてリターンします。

accelerator_get_version_info

mixed accelerator_get_version_info()

コード高速化機能のバージョンとライセンス情報をPHP 配列ととしてリターンします。

accelerator_get_blacklisted_paths

mixed accelerator_get_blacklisted_paths()

コード高速化ブラックリストに登録されているコンテンツ （例えば、キャッシュ対象のコンテンツ以外） のパス名一覧をリターンします。

output_cache_get_statistics

mixed output_cache_get_statistics()

コンテンツキャッシュの統計情報をリターンします。

output_cache_disable_compression

void output_cache_disable_compression()

ページを圧縮してキャッシュする振る舞いを無効にします。 グローバル設定でファイル圧縮が有効に設定されていても、 出力をキャッシュすることはありません。

キャッシュ情報API

output_cache_check_file

mixed output_cache_check_file($filename)

string $filename

照合するファイル名

現在のキャッシュ構成とスクリプトファイル名を照合し、スクリプトの出力がキャッシュ可能である否かを確認します。 ファイルがキャッシュ可能でない場合は、‘false’ をリターンします。

output_cache_enabled

mixed output_cache_enabled()

コンテンツキャッシュが有効か否かを検査します。

output_cache_disable

void output_cache_disable()

現在、実行中のキャッシュしているスクリプトの出力を無効にします。

コンテンツキャッシュAPI

output_cache_fetch

string output_cache_fetch($key, $script, $lifetime)

string $key

キャッシュID。任意の名前を指定できます。

string $script

キャッシュを生成するコード。動作はeval("return $script;") と同等。

int $lifetime

キャッシュの有効期限（単位：秒）。

キャッシュされたコンテンツを取得します。 キャッシュの有効期限が切れていた若しくはキャッシュが存在しない場合は、$scriptの実行結果を返すとともにキャッシュを作成します。

output_cache_output

void output_cache_output($key, $script, $lifetime)

string $key

キャッシュID。任意の名前を指定できます。

string $script

キャッシュを生成するコード。動作はeval("return $script;") と同等。

int $lifetime

キャッシュの有効期限（単位：秒）。

output_cache_fetchとの違いは、コンテンツを戻り値として返すのではなく、そのまま出力(echo)します。 それ以外は、output_cache_fetchと同等の動作をします。

output_cache_remove

void output_cache_remove($filename)

string $filename

削除したいファイル。

指定したファイルに関するキャッシュを削除します。 ファイル名はフルパスで、ローカル上のパスを指定します。

使用例：

output_cache_remove("/var/www/html/foo.php");

output_cache_remove_url

void output_cache_remove_url($url)

string $url

削除したいキャッシュのURL。

指定したURLで登録されているコンテンツキャッシュを削除します。 ZPSの管理画面で登録したコンテンツキャッシュのURLを指定して下さい。

output_cache_remove_key

void output_cache_remove_key($key)

string $key

削除したいキャッシュのキー。

output_cache_fetch/output_cache_outputで指定したIDを指定して削除します。

output_cache_put

void output_cache_put($key, $data)

string $key

キャッシュID。任意の名前を指定できます。

mixed $data

キャッシュしたいデータ。

キャッシュを作成します。 $dataの型に制限はありません。キャッシュを作成する際に自動的にシリアライズされます。

output_cache_get

mixed output_cache_get($key, $lifetime)

string $key

キャッシュID。任意の名前を指定できます。

int $lifetime

キャッシュの有効期限（単位：秒）。

キャッシュを取得します。 キャッシュデータは、キャッシュ作成時の状態に自動的にデシリアライズされます。 該当するキャッシュが存在しない若しくは有効期限を超過している場合は、falseを返します。

output_cache_exists

boolean output_cahce_exists($key, $lifetime)

string $key

キャッシュID。任意の名前を指定できます。

int $lifetime

キャッシュの有効期限（単位：秒）。

キャッシュの有無判定とキャッシュの登録を開始をします。 該当するキャッシュが存在し、且つ有効期限内であった場合にはtrueを、それ以外の場合にはfalseを返します。

キャッシュが存在しない若しくは有効期限を超過した場合、キャッシュの登録を開始します。 キャッシュの登録を完了するには、output_cache_stop（後述）を用います。 使用例は次の通りです。

<?php
if (!output_cache_exists("foo", 3600)) {
   echo date("Y-m-d H:i:s");
   output_cache_stop();
}
?>

このAPI関数の動作は、PHPの出力バッファ制御関数に類似しています。 下記は、出力バッファ制御関数に置き換えてみたスクリプトです。

<?php
$cache = NULL;
if (is_null($cache)) {
    ob_start();
    echo date("Y-m-d H:i:s");
    $cache = ob_get_contents();
    ob_end_clean();
}
?>

output_cache_stop

void output_cache_stop()

キャッシュ登録処理を終了します。 output_cache_existsと組み合わせて使用します。 詳しくは、output_cache_existsの解説をご覧になって下さい。