Docs For Class Ethna_Plugin

Ethna_Plugin_Cachemanager

Description

キャッシュマネージャプラグインクラス

author: Masaki Fujimoto <fujimoto@php.net>
access: public

Located in /class/Plugin/Ethna_Plugin_Cachemanager.php (line 19)

Direct descendents

Class	Description
Ethna_Plugin_Cachemanager_Memcache	キャッシュマネージャクラス(memcache版)
Ethna_Plugin_Cachemanager_Localfile	キャッシュマネージャクラス(ローカルファイルキャッシュ版)

Method Summary

Ethna_Plugin_Cachemanager Ethna_Plugin_Cachemanager ( &$controller)

void clear (string $key, [string $namespace = null])

mixed get (string $key, [int $lifetime = null], [string $namespace = null])

int getLastModified (string $key, [string $namespace = null])

string getNamespace ( $namespace)

void isCached (string $key, [ $timestamp = null], [string $namespace = null], int $lifetime)

bool lock (string $key, [int $timeout = 5], [string $namespace = null])

void set (string $key, mixed $value, [int $timestamp = null], [string $namespace = null])

void setCompress (bool $flag)

void setNamespace (string $namespace)

bool unlock (string $key, [string $namespace = null])

Methods

Constructor Ethna_Plugin_Cachemanager (line 39)

Ethna_Plugin_Cachemanagerクラスのコンストラクタ

access: public

Ethna_Plugin_Cachemanager Ethna_Plugin_Cachemanager ( &$controller)

&$controller

clear (line 130)

キャッシュから値を削除する

access: public

void clear (string $key, [string $namespace = null])

string $key: キャッシュキー
string $namespace: キャッシュネームスペース

Redefined in descendants as:

Ethna_Plugin_Cachemanager_Memcache::clear() : キャッシュ値を削除する
Ethna_Plugin_Cachemanager_Localfile::clear() : キャッシュ値を削除する

get (line 82)

キャッシュに設定された値を取得する

キャッシュに値が設定されている場合はキャッシュ値が戻り値となる。キャッシュに値が無い場合やlifetime を過ぎている場合、エラーが発生した場合はEthna_Error オブジェクトが戻り値となる。

return: キャッシュ値
access: public

mixed get (string $key, [int $lifetime = null], [string $namespace = null])

string $key: キャッシュキー
int $lifetime: キャッシュ有効期間
string $namespace: キャッシュネームスペース

Redefined in descendants as:

Ethna_Plugin_Cachemanager_Memcache::get() : キャッシュに設定された値を取得する
Ethna_Plugin_Cachemanager_Localfile::get() : キャッシュに設定された値を取得する

getLastModified (line 94)

キャッシュの最終更新日時を取得する

return: 最終更新日時(unixtime)
access: public

int getLastModified (string $key, [string $namespace = null])

string $key: キャッシュキー
string $namespace: キャッシュネームスペース

Redefined in descendants as:

Ethna_Plugin_Cachemanager_Memcache::getLastModified() : キャッシュの最終更新日時を取得する
Ethna_Plugin_Cachemanager_Localfile::getLastModified() : キャッシュの最終更新日時を取得する

getNamespace (line 52)

キャッシュネームスペースを取得する

return: 現在のキャッシュネームスペース
access: public

string getNamespace ( $namespace)

$namespace

isCached (line 119)

値がキャッシュされているかどうかを取得する

access: public

void isCached (string $key, [ $timestamp = null], [string $namespace = null], int $lifetime)

string $key: キャッシュキー
int $lifetime: キャッシュ有効期間
string $namespace: キャッシュネームスペース
$timestamp

Redefined in descendants as:

Ethna_Plugin_Cachemanager_Memcache::isCached() : 値がキャッシュされているかどうかを取得する
Ethna_Plugin_Cachemanager_Localfile::isCached() : 値がキャッシュされているかどうかを取得する

lock (line 143)

キャッシュデータをロックする

return: true:成功 false:失敗
access: public

bool lock (string $key, [int $timeout = 5], [string $namespace = null])

string $key: キャッシュキー
int $timeout: ロックタイムアウト
string $namespace: キャッシュネームスペース

Redefined in descendants as:

Ethna_Plugin_Cachemanager_Memcache::lock() : キャッシュデータをロックする

set (line 107)

キャッシュに値を設定する

access: public

void set (string $key, mixed $value, [int $timestamp = null], [string $namespace = null])

string $key: キャッシュキー
mixed $value: キャッシュ値
int $timestamp: キャッシュ最終更新時刻(unixtime)
string $namespace: キャッシュネームスペース

Redefined in descendants as:

Ethna_Plugin_Cachemanager_Memcache::set() : キャッシュに値を設定する
Ethna_Plugin_Cachemanager_Localfile::set() : キャッシュに値を設定する

setCompress (line 169)

圧縮フラグを立てる

MySQLなどいくつかの子クラスで有効

access: public

void setCompress (bool $flag)

bool $flag: フラグ

Redefined in descendants as:

Ethna_Plugin_Cachemanager_Memcache::setCompress() : 圧縮フラグを立てる

setNamespace (line 63)

キャッシュネームスペースを設定する

access: public

void setNamespace (string $namespace)

string $namespace: ネームスペース

unlock (line 156)

キャッシュデータのロックを解除する

return: true:成功 false:失敗
access: public

bool unlock (string $key, [string $namespace = null])

string $key: キャッシュキー
string $namespace: キャッシュネームスペース

Redefined in descendants as:

Ethna_Plugin_Cachemanager_Memcache::unlock() : キャッシュデータのロックを解除する

Documentation generated on Fri, 11 Nov 2011 04:00:02 +0900 by phpDocumentor 1.4.3