Yii Framework v1.1.10 类参考
CWinCache
| 包 | system.caching |
|---|---|
| 继承 | class CWinCache » CCache » CApplicationComponent » CComponent |
| 实现 | ArrayAccess, ICache, IApplicationComponent |
| 源自 | 1.1.2 |
| 版本 | $Id: CWinCache.php 2799 2011-01-01 19:31:13Z qiang.xue $ |
| 源码 | framework/caching/CWinCache.php |
公共属性
| 属性 | 类型 | 描述 | 定义在 |
|---|---|---|---|
| behaviors | array | 这个应用组件附加的行为。 这此行为将在应用组件调用init时附加在应用组件上。 请参照CModel::behaviors如何指定此属性值。 | CApplicationComponent |
| isInitialized | boolean | 检查应用组件是否已经初始化。 | CApplicationComponent |
| keyPrefix | string | 加在每个缓存键名前的字符串以保证键名是唯一的。默认值是application ID。 | CCache |
公共方法
受保护方法
| 方法 | 描述 | 定义在 |
|---|---|---|
| addValue() | 仅仅在甄别缓存值的键名不存在的情况下，往缓存中存储值。 | CWinCache |
| deleteValue() | 从缓存中删除指定键名对应的值 | CWinCache |
| flushValues() | 删除所有缓存值。 | CWinCache |
| generateUniqueKey() | CCache | |
| getValue() | 从缓存中检索一个匹配指定键名的值。 | CWinCache |
| getValues() | 从缓存中检索出多个匹配指定键名的值。 | CWinCache |
| setValue() | 往缓存中存储一个用键名区分的值。 | CWinCache |
方法详细
addValue()
方法
|
protected boolean addValue(string $key, string $value, integer $expire)
| ||
| $key | string | 用以甄别缓存值的键名 |
| $value | string | 要缓存的值 |
| $expire | integer | 以秒为单位的数值，表示缓存的过期时间。为0则永不过期。 |
| {return} | boolean | 成功存储到缓存中则返回true，否则返回false |
源码： framework/caching/CWinCache.php#83 (显示)
protected function addValue($key,$value,$expire)
{
return wincache_ucache_add($key,$value,$expire);
}
仅仅在甄别缓存值的键名不存在的情况下，往缓存中存储值。 这是在父类中定义的方法的具体实现。
deleteValue()
方法
|
protected boolean deleteValue(string $key)
| ||
| $key | string | 要删除值的键名 |
| {return} | boolean | 如果删除期间没有发生错误 |
源码： framework/caching/CWinCache.php#94 (显示)
protected function deleteValue($key)
{
return wincache_ucache_delete($key);
}
从缓存中删除指定键名对应的值 这是在父类中定义的方法的具体实现。
flushValues()
方法
（可用自 v1.1.5）
|
protected boolean flushValues()
| ||
| {return} | boolean | 如果清空操作成功执行。 |
源码： framework/caching/CWinCache.php#105 (显示)
protected function flushValues()
{
return wincache_ucache_clear();
}
删除所有缓存值。 这是在父类中定义的方法的具体实现。
getValue()
方法
|
protected string getValue(string $key)
| ||
| $key | string | 用以甄别缓存值的唯一键名 |
| {return} | string | 缓存中存储的值，如果该值不存在或者已过期则返回false。 |
源码： framework/caching/CWinCache.php#45 (显示)
protected function getValue($key)
{
return wincache_ucache_get($key);
}
从缓存中检索一个匹配指定键名的值。 这是在父类中定义的方法的具体实现。
getValues()
方法
|
protected array getValues(array $keys)
| ||
| $keys | array | 用以甄别缓存值的键名列表 |
| {return} | array | 以$keys为键名的缓存值列表 |
源码： framework/caching/CWinCache.php#55 (显示)
protected function getValues($keys)
{
return wincache_ucache_get($keys);
}
从缓存中检索出多个匹配指定键名的值。
init()
方法
|
public void init()
|
源码： framework/caching/CWinCache.php#30 (显示)
public function init()
{
parent::init();
if(!extension_loaded('wincache'))
throw new CException(Yii::t('yii', 'CWinCache requires PHP wincache extension to be loaded.'));
if(!ini_get('wincache.ucenabled'))
throw new CException(Yii::t('yii', 'CWinCache user cache is disabled. Please set wincache.ucenabled to On in your php.ini.'));
}
初始化应用程序组件。 该方法在接口IApplicationComponent中有要求。 它检查WinCache扩展和WinCache用户缓存是否可用。
setValue()
方法
|
protected boolean setValue(string $key, string $value, integer $expire)
| ||
| $key | string | 用以甄别缓存值的键名 |
| $value | string | 要缓存的值 |
| $expire | integer | 以秒为单位的数值，表示缓存的过期时间。为0则永不过期。 |
| {return} | boolean | 成功存储到缓存中则返回true，否则返回false |
源码： framework/caching/CWinCache.php#69 (显示)
protected function setValue($key,$value,$expire)
{
return wincache_ucache_set($key,$value,$expire);
}
往缓存中存储一个用键名区分的值。 这是在父类中定义的方法的具体实现。