首页 » Yii中文参考手册 » system.caching
网站地图
dd

CMemCache

包 system.caching
继承 class CMemCache » CCache » CApplicationComponent » CComponent
实现 ArrayAccess, ICache, IApplicationComponent
源自 1.0
版本 $Id: CMemCache.php 3515 2011-12-28 12:29:24Z mdomba $
源码
CMemCache基于memcached实现一个缓存应用组件。

通过设置servers属性，可以为CMemCache 设置一系列的memcache服务器。默认情况，CMemCache认为只有 一台memcache服务器位于localhost的11211端口。

查看CCache操作手册以了解CMemCache支持的常用缓存操作。

注意，没有安全措施以保护memcache中的数据。 运行于系统中的任何进程都可以访问memcache中的所有数据。

要使用CMemCache作为缓存应用组件，如下配置应用程序： 
array(
    'components'=>array(
        'cache'=>array(
            'class'=>'CMemCache',
            'servers'=>array(
                array(
                    'host'=>'server1',
                    'port'=>11211,
                    'weight'=>60,
                ),
                array(
                    'host'=>'server2',
                    'port'=>11211,
                    'weight'=>40,
                ),
            ),
        ),
    ),
)
在上面，使用了两个memcache服务器：server1和server2。 你可以设置每个服务器的属性，包括： host, port, persistent, weight, timeout, retryInterval, status. 参见http://www.php.net/manual/en/function.memcache-addserver.php 了解更多详情

memcached也可以使用CMemCache。 设置useMemcached为true以使用memcached。

公共属性

属性 类型 描述 定义在
behaviors array 这个应用组件附加的行为。 这此行为将在应用组件调用init时附加在应用组件上。 请参照CModel::behaviors如何指定此属性值。 CApplicationComponent
isInitialized boolean 检查应用组件是否已经初始化。 CApplicationComponent
keyPrefix string 加在每个缓存键名前的字符串以保证键名是唯一的。默认值是application ID。 CCache
memCache mixed 本组件使用的memcache实例（或者memcached实例当useMemcached为true）。 CMemCache
servers array memcache服务器配置列表。每个元素都是一个CMemCacheServerConfiguration。 CMemCache
useMemcached boolean 是否使用memcached或者memcache作为底层缓存扩展。 若为true，则使用{@link http://pecl. CMemCache

公共方法

方法 描述 定义在
__call() 如果类中没有调的方法名，则调用这个方法。 CComponent
__get() 返回一个属性值、一个事件处理程序列表或一个行为名称。 CComponent
__isset() 检查一个属性是否为null。 CComponent
__set() 设置一个组件的属性值。 CComponent
__unset() 设置一个组件的属性为null。 CComponent
add() 仅仅在甄别缓存值的键名不存在的情况下，往缓存中存储值。 CCache
asa() 返回这个名字的行为对象。 CComponent
attachBehavior() 附加一个行为到组件。 CComponent
attachBehaviors() 附加一个行为列表到组件。 CComponent
attachEventHandler() 为事件附加一个事件处理程序。 CComponent
canGetProperty() 确定属性是否可读。 CComponent
canSetProperty() 确定属性是否可写。 CComponent
delete() 从缓存中删除指定键名对应的值 CCache
detachBehavior() 从组件中分离一个行为。 CComponent
detachBehaviors() 从组件中分离所有行为。 CComponent
detachEventHandler() 分离一个存在的事件处理程序。 CComponent
disableBehavior() 禁用一个附加行为。 CComponent
disableBehaviors() 禁用组件附加的所有行为。 CComponent
enableBehavior() 启用一个附加行为。 CComponent
enableBehaviors() 启用组件附加的所有行为。 CComponent
evaluateExpression() 计算一个PHP表达式，或根据组件上下文执行回调。 CComponent
flush() 删除所有缓存值。 CCache
get() 从缓存中检索一个匹配指定键名的值。 CCache
getEventHandlers() 返回一个事件的附加处理程序列表。 CComponent
getIsInitialized() 检查应用组件是否已经初始化。 CApplicationComponent
getMemCache() 返回本组件使用的memcache实例（或者memcached实例当useMemcached为true）。 CMemCache
getServers() 返回memcache服务器配置列表。每个元素都是一个CMemCacheServerConfiguration。 CMemCache
hasEvent() 确定一个事件是否定义。 CComponent
hasEventHandler() 检查事件是否有附加的处理程序。 CComponent
hasProperty() 确定属性是否被定义。 CComponent
init() 初始化应用程序组件。 CMemCache
mget() 从缓存中检索出多个匹配指定键名的值。 CCache
offsetExists() 返回指定键名的缓存条目是否存在。 CCache
offsetGet() 从缓存中检索一个匹配指定键名的值。 CCache
offsetSet() 往缓存中存储一个用键名区分的值。 CCache
offsetUnset() 从缓存中删除指定键名对应的值 CCache
raiseEvent() 发起一个事件。 CComponent
set() 根据一个用以甄别的键名往缓存中存储一个值。 CCache
setServers() 设置memcache服务器配置列表。每个元素必须是一个数组， 包含如下键名：host, port, persistent, weight, timeout, retryInterval, status。 CMemCache

受保护方法

方法 描述 定义在
addValue() 仅仅在甄别缓存值的键名不存在的情况下，往缓存中存储值。 CMemCache
deleteValue() 从缓存中删除指定键名对应的值 CMemCache
flushValues() 删除所有缓存值。 CMemCache
generateUniqueKey() CCache
getValue() 从缓存中检索一个匹配指定键名的值。 CMemCache
getValues() 从缓存中检索出多个匹配指定键名的值。 CMemCache
setValue() 往缓存中存储一个用键名区分的值。 CMemCache

属性详细

memCache 属性 只读
public mixed getMemCache()

本组件使用的memcache实例（或者memcached实例当useMemcached为true）。

servers 属性
public array getServers()
public void setServers(array $config)

memcache服务器配置列表。每个元素都是一个CMemCacheServerConfiguration。

useMemcached 属性
public boolean $useMemcached;

是否使用memcached或者memcache作为底层缓存扩展。 若为true，则使用memcached。 若为false，则使用memcache。 Defaults to false.

方法详细

addValue() 方法
protected boolean addValue(string $key, string $value, integer $expire)
$key string 用以甄别缓存值的键名
$value string 要缓存的值
$expire integer 以秒为单位的数值，表示缓存的过期时间。为0则永不过期。
{return} boolean 成功存储到缓存中则返回true，否则返回false 

protected function addValue($key,$value,$expire)
{
    if($expire>0)
        $expire+=time();
    else
        $expire=0;

    return $this->useMemcached ? $this->_cache->add($key,$value,$expire) : $this->_cache->add($key,$value,0,$expire);
}

仅仅在甄别缓存值的键名不存在的情况下，往缓存中存储值。 这是在父类中定义的方法的具体实现。

deleteValue() 方法
protected boolean deleteValue(string $key)
$key string 要删除值的键名
{return} boolean 如果删除期间没有发生错误 

protected function deleteValue($key)
{
    return $this->_cache->delete($key, 0);
}

从缓存中删除指定键名对应的值 这是在父类中定义的方法的具体实现。

flushValues() 方法 （可用自 v1.1.5）
protected boolean flushValues()
{return} boolean 如果清空操作成功执行。 

protected function flushValues()
{
    return $this->_cache->flush();
}

删除所有缓存值。 这是在父类中定义的方法的具体实现。

getMemCache() 方法
public mixed getMemCache()
{return} mixed 本组件使用的memcache实例（或者memcached实例当useMemcached为true）。 

public function getMemCache()
{
    if($this->_cache!==null)
        return $this->_cache;
    else
        return $this->_cache=$this->useMemcached ? new Memcached : new Memcache;
}

getServers() 方法
public array getServers()
{return} array memcache服务器配置列表。每个元素都是一个CMemCacheServerConfiguration。 

public function getServers()
{
    return $this->_servers;
}

getValue() 方法
protected string getValue(string $key)
$key string 用以甄别缓存值的唯一键名
{return} string 缓存中存储的值，如果该值不存在或者已过期则返回false。 

protected function getValue($key)
{
    return $this->_cache->get($key);
}

从缓存中检索一个匹配指定键名的值。 这是在父类中定义的方法的具体实现。

getValues() 方法
protected array getValues(array $keys)
$keys array 用以甄别缓存值的键名列表
{return} array 以$keys为键名的缓存值列表 

protected function getValues($keys)
{
    return $this->useMemcached ? $this->_cache->getMulti($keys) : $this->_cache->get($keys);
}

从缓存中检索出多个匹配指定键名的值。

init() 方法
public void init()

public function init()
{
    parent::init();
    $servers=$this->getServers();
    $cache=$this->getMemCache();
    if(count($servers))
    {
        foreach($servers as $server)
        {
            if($this->useMemcached)
                $cache->addServer($server->host,$server->port,$server->weight);
            else
                $cache->addServer($server->host,$server->port,$server->persistent,$server->weight,$server->timeout,$server->status);
        }
    }
    else
        $cache->addServer('localhost',11211);
}

初始化应用程序组件。 该方法在接口IApplicationComponent中有要求。 它创建memcache实例并且添加memcache服务器。

setServers() 方法
public void setServers(array $config)
$config array memcache服务器配置列表。每个元素必须是一个数组， 包含如下键名：host, port, persistent, weight, timeout, retryInterval, status。 

public function setServers($config)
{
    foreach($config as $c)
        $this->_servers[]=new CMemCacheServerConfiguration($c);
}

参见

setValue() 方法
protected boolean setValue(string $key, string $value, integer $expire)
$key string 用以甄别缓存值的键名
$value string 要缓存的值
$expire integer 以秒为单位的数值，表示缓存的过期时间。为0则永不过期。
{return} boolean 成功存储到缓存中则返回true，否则返回false 

protected function setValue($key,$value,$expire)
{
    if($expire>0)
        $expire+=time();
    else
        $expire=0;

    return $this->useMemcached ? $this->_cache->set($key,$value,$expire) : $this->_cache->set($key,$value,0,$expire);
}

往缓存中存储一个用键名区分的值。 这是在父类中定义的方法的具体实现。