ICache - YII 类库手册

所有包 | 方法

包	system.caching
继承	interface ICache
子类	CApcCache, CCache, CDbCache, CDummyCache, CEAcceleratorCache, CFileCache, Cmemcache, CWinCache, CXCache, CZendDataCache
源自	1.0
版本	$Id: interfaces.PHP 3515 2011-12-28 12:29:24Z mDOMba $
源码

ICache是所有缓存组件必须实现的接口。

支持缓存功能的类必须实现这个接口。

公共方法

方法	描述	定义在
add()	如果缓存不包含此键，通过一个键作为值的标识存储到缓存中。	ICache
delete()	从缓存中删除一个指定键的值	ICache
flush()	从缓存中删除所有值。	ICache
get()	从缓存中检索指定的键对应的值。	ICache
mget()	从缓存中检索指定多个键对应的值。	ICache
set()	通过一个键作为值的标识存储到缓存中。	ICache

add() 方法

abstract public boolean add(string $id, mixed $value, integer $expire=0, ICacheDependency $dependency=NULL)
$id	string	一个标识缓存值对应的键
$value	mixed	存入缓存中的值
$expire	integer	这个数字单位是秒，用来指定缓存中的值的过期时间。0意味着永不过期。
$dependency	ICacheDependency	缓存依赖项。如果依赖改变，该项将被标记为无效。
{return}	boolean	如果这个值成功存储到缓存返回true，否则为false。


public function add($id,$value,$expire=0,$dependency=null);

如果缓存不包含此键，通过一个键作为值的标识存储到缓存中。如果缓存中已经包含了键，将什么都不会做。

delete() 方法

abstract public boolean delete(string $id)
$id	string	一个要删除的值对应的键
{return}	boolean	是否删除成功


public function delete($id);

从缓存中删除一个指定键的值

flush() 方法

abstract public boolean flush()
{return}	boolean	是否删除成功。


public function flush();

从缓存中删除所有值。执行此操作请小心，可能缓存被多个应用程序共享。

get() 方法

abstract public mixed get(string $id)
$id	string	一个标识缓存值对应的键
{return}	mixed	缓存中存储的值，如果缓存中没有或已经过期返回false。


public function get($id);

从缓存中检索指定的键对应的值。

mget() 方法

abstract public array mget(array $ids)
$ids	array	多少标识缓存值对应的键列表
{return}	array	指定键列表对应的缓存值列表。这个数组是以（键，值）对返回。如果这个值不在缓存中或已经过期，对应数据中的值将为false。


public function mget($ids);

从缓存中检索指定多个键对应的值。一些缓存（如memcache，apc）允许一次检索多个缓存值，这会提高性能，因为它降低了通信的成本。如果缓存本身不支持此功能，它会模拟这种方法。

set() 方法

abstract public boolean set(string $id, mixed $value, integer $expire=0, ICacheDependency $dependency=NULL)
$id	string	一个标识缓存值对应的键
$value	mixed	存入缓存中的值
$expire	integer	这个数字单位是秒，用来指定缓存中的值的过期时间。0意味着永不过期。
$dependency	ICacheDependency	缓存依赖项。如果依赖改变，该项将被标记为无效。
{return}	boolean	如果这个值成功存储到缓存返回true，否则为false。


public function set($id,$value,$expire=0,$dependency=null);

通过一个键作为值的标识存储到缓存中。如果缓存中已经包含了这样一个键，已经存在的值或过期的值将被新值代替。