Docs For Class Ethna_Plugin_Cachemanager

Description

キャッシュマネージャクラス(memcache版)

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

Located in /class/Plugin/Cachemanager/Memcache.php (line 23)

Ethna_Plugin_Abstract
   |
   --Ethna_Plugin_Cachemanager
      |
      --Ethna_Plugin_Cachemanager_Memcache

Variable Summary

bool $compress

array $config_default

Method Summary

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

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

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

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

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)

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

void _getMemcache ( $cache_key, [ $namespace = null])

array _getMemcacheInfo ( $cache_key, $namespace)

void _load ()

Variables

bool $compress = true (line 31)

var: 圧縮フラグ
access: protected

array $config_default = array(
'host' => 'localhost',
'port' => '11211',
'retry' => 3,
'timeout' => 3,
) (line 34)

var: plugin configure
access: protected

Redefinition of:

Ethna_Plugin_Abstract::$config_default

Inherited Variables

Inherited from Ethna_Plugin_Cachemanager

Ethna_Plugin_Cachemanager::$namespace

Inherited from Ethna_Plugin_Abstract

Ethna_Plugin_Abstract::$action_form
Ethna_Plugin_Abstract::$af
Ethna_Plugin_Abstract::$backend
Ethna_Plugin_Abstract::$config
Ethna_Plugin_Abstract::$controller
Ethna_Plugin_Abstract::$ctl
Ethna_Plugin_Abstract::$logger
Ethna_Plugin_Abstract::$name
Ethna_Plugin_Abstract::$session
Ethna_Plugin_Abstract::$type

Methods

clear (line 252)

キャッシュ値を削除する

access: public

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

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

Redefinition of:

Ethna_Plugin_Cachemanager::clear(): キャッシュから値を削除する

get (line 145)

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

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

return: キャッシュ値
access: public

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

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

Redefinition of:

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

getLastModified (line 184)

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

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

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

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

Redefinition of:

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

isCached (line 211)

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

access: public

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

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

Redefinition of:

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

lock (line 278)

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

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

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

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

Redefinition of:

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

set (line 227)

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

access: public

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

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

Redefinition of:

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

setCompress (line 351)

圧縮フラグを立てる

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

access: public

void setCompress (bool $flag)

bool $flag: フラグ

Redefinition of:

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

unlock (line 314)

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

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

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

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

Redefinition of:

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

_getMemcache (line 59)

memcacheキャッシュオブジェクトを生成、取得する

access: protected

void _getMemcache ( $cache_key, [ $namespace = null])

$cache_key
$namespace

_getMemcacheInfo (line 102)

memcache接続情報を取得する

return: array(host, port)
todo: $cache_keyから$indexを決める方法を変更できるようにする
access: protected

array _getMemcacheInfo ( $cache_key, $namespace)

$cache_key
$namespace

_load (line 48)

_load

access: protected

void _load ()

Redefinition of:

Ethna_Plugin_Cachemanager::_load(): _load

Inherited Methods

Inherited From Ethna_Plugin_Cachemanager

Ethna_Plugin_Cachemanager::clear()
Ethna_Plugin_Cachemanager::get()
Ethna_Plugin_Cachemanager::getLastModified()
Ethna_Plugin_Cachemanager::getNamespace()
Ethna_Plugin_Cachemanager::isCached()
Ethna_Plugin_Cachemanager::lock()
Ethna_Plugin_Cachemanager::set()
Ethna_Plugin_Cachemanager::setCompress()
Ethna_Plugin_Cachemanager::setNamespace()
Ethna_Plugin_Cachemanager::unlock()
Ethna_Plugin_Cachemanager::_load()

Inherited From Ethna_Plugin_Abstract

Ethna_Plugin_Abstract::__construct()
Ethna_Plugin_Abstract::getConfig()
Ethna_Plugin_Abstract::getName()
Ethna_Plugin_Abstract::getType()
Ethna_Plugin_Abstract::_detectName()
Ethna_Plugin_Abstract::_detectType()
Ethna_Plugin_Abstract::_load()
Ethna_Plugin_Abstract::_loadConfig()