Docs For Class Ethna_Plugin

Description

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

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

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

Ethna_Plugin_Abstract
   |
   --Ethna_Plugin_Cachemanager

Direct descendents

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

Variable Summary

string $namespace

Method Summary

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 = null])

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])

void _load ()

Variables

string $namespace = '' (line 24)

var: 現在のネームスペース
access: protected

Inherited Variables

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::$config_default
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 129)

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

access: public

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

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

Redefined in descendants as:

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

get (line 81)

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

キャッシュに値が設定されている場合はキャッシュ値が戻り値となる。キャッシュに値が無い場合や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_Localfile::get() : キャッシュに設定された値を取得する
Ethna_Plugin_Cachemanager_Memcache::get() : キャッシュに設定された値を取得する
Ethna_Plugin_Cachemanager_Memcached::get() : get cached data

getLastModified (line 93)

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

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

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

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

Redefined in descendants as:

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

getNamespace (line 46)

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

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

string getNamespace ([ $namespace = null])

$namespace

isCached (line 118)

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

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_Localfile::isCached() : 値がキャッシュされているかどうかを取得する
Ethna_Plugin_Cachemanager_Memcache::isCached() : 値がキャッシュされているかどうかを取得する
Ethna_Plugin_Cachemanager_Memcached::isCached() : check cache exists

lock (line 142)

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

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() : キャッシュデータをロックする
Ethna_Plugin_Cachemanager_Memcached::lock() : キャッシュデータをロックする

set (line 106)

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

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_Localfile::set() : キャッシュに値を設定する
Ethna_Plugin_Cachemanager_Memcache::set() : キャッシュに値を設定する
Ethna_Plugin_Cachemanager_Memcached::set() : set cache

setCompress (line 168)

圧縮フラグを立てる

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

access: public

void setCompress (bool $flag)

bool $flag: フラグ

Redefined in descendants as:

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

setNamespace (line 62)

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

access: public

void setNamespace (string $namespace)

string $namespace: ネームスペース

unlock (line 155)

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

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() : キャッシュデータのロックを解除する
Ethna_Plugin_Cachemanager_Memcached::unlock() : キャッシュデータのロックを解除する

_load (line 33)

_load

access: protected

void _load ()

Redefinition of:

Ethna_Plugin_Abstract::_load(): _load

Redefined in descendants as:

Ethna_Plugin_Cachemanager_Memcache::_load() : _load
Ethna_Plugin_Cachemanager_Memcached::_load() : _load

Inherited Methods

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()