mirror of
https://github.com/yiisoft/yii.git
synced 2026-03-07 08:36:55 +01:00
d8baee7a8f
changed how translatable messages in validators are specified. updated message extractor command. updated requirement checker.
252 lines
7.1 KiB
PHP
252 lines
7.1 KiB
PHP
<?php
|
|
/**
|
|
* CMemCache class file
|
|
*
|
|
* @author Qiang Xue <qiang.xue@gmail.com>
|
|
* @link http://www.yiiframework.com/
|
|
* @copyright Copyright © 2008 Yii Software LLC
|
|
* @license http://www.yiiframework.com/license/
|
|
*/
|
|
|
|
/**
|
|
* CMemCache implements a cache application component based on {@link http://www.danga.com/memcached/ memcached}.
|
|
*
|
|
* CMemCache can be configured with a list of memcache servers by settings
|
|
* its {@link setServers servers} property. By default, CMemCache assumes
|
|
* there is a memcache server running on localhost at port 11211.
|
|
*
|
|
* See {@link CCache} manual for common cache operations that are supported by CMemCache.
|
|
*
|
|
* Note, there is no security measure to protected data in memcache.
|
|
* All data in memcache can be accessed by any process running in the system.
|
|
*
|
|
* To use CMemCache as the cache application component, configure the application as follows,
|
|
* <pre>
|
|
* array(
|
|
* 'components'=>array(
|
|
* 'cache'=>array(
|
|
* 'class'=>'CMemCache',
|
|
* 'servers'=>array(
|
|
* array(
|
|
* 'host'=>'server1',
|
|
* 'port'=>11211,
|
|
* 'weight'=>60,
|
|
* ),
|
|
* array(
|
|
* 'host'=>'server2',
|
|
* 'port'=>11211,
|
|
* 'weight'=>40,
|
|
* ),
|
|
* ),
|
|
* ),
|
|
* ),
|
|
* )
|
|
* </pre>
|
|
* In the above, two memcache servers are used: server1 and server2.
|
|
* You can configure more properties of every server, including:
|
|
* host, port, persistent, weight, timeout, retryInterval, status.
|
|
* See {@link http://www.php.net/manual/en/function.memcache-addserver.php}
|
|
* for more details.
|
|
*
|
|
* @author Qiang Xue <qiang.xue@gmail.com>
|
|
* @version $Id$
|
|
* @package system.caching
|
|
* @since 1.0
|
|
*/
|
|
class CMemCache extends CCache
|
|
{
|
|
/**
|
|
* @var Memcache the Memcache instance
|
|
*/
|
|
private $_cache=null;
|
|
/**
|
|
* @var array list of memcache server configurations
|
|
*/
|
|
private $_servers=array();
|
|
|
|
/**
|
|
* Initializes this application component.
|
|
* This method is required by the {@link IApplicationComponent} interface.
|
|
* It creates the memcache instance and adds memcache servers.
|
|
* @throws CException if memcache extension is not loaded
|
|
*/
|
|
public function init()
|
|
{
|
|
parent::init();
|
|
if(!extension_loaded('memcache'))
|
|
throw new CException(Yii::t('yii#CMemCache requires PHP memcache extension to be loaded.'));
|
|
|
|
$servers=$this->getServers();
|
|
$cache=$this->getMemCache();
|
|
if(count($servers))
|
|
{
|
|
foreach($servers as $server)
|
|
{
|
|
$cache->addServer($server->host,$server->port,$server->persistent,
|
|
$server->weight,$server->timeout,$server->status);
|
|
}
|
|
}
|
|
else
|
|
$cache->addServer('localhost',11211);
|
|
}
|
|
|
|
/**
|
|
* @return Memcache the memcache instance
|
|
*/
|
|
protected function getMemCache()
|
|
{
|
|
if($this->_cache!==null)
|
|
return $this->_cache;
|
|
else
|
|
return $this->_cache=new Memcache;
|
|
}
|
|
|
|
/**
|
|
* @return array list of memcache server configurations. Each element is a {@link CMemCacheServerConfiguration}.
|
|
*/
|
|
public function getServers()
|
|
{
|
|
return $this->_servers;
|
|
}
|
|
|
|
/**
|
|
* @param array list of memcache server configurations. Each element must be an array
|
|
* with the following keys: host, port, persistent, weight, timeout, retryInterval, status.
|
|
* @see http://www.php.net/manual/en/function.Memcache-addServer.php
|
|
*/
|
|
public function setServers($config)
|
|
{
|
|
foreach($config as $c)
|
|
$this->_servers[]=new CMemCacheServerConfiguration($c);
|
|
}
|
|
|
|
/**
|
|
* Retrieves a value from cache with a specified key.
|
|
* This is the implementation of the method declared in the parent class.
|
|
* @param string a unique key identifying the cached value
|
|
* @return string the value stored in cache, false if the value is not in the cache or expired.
|
|
*/
|
|
protected function getValue($key)
|
|
{
|
|
return $this->_cache->get($key);
|
|
}
|
|
|
|
/**
|
|
* Stores a value identified by a key in cache.
|
|
* This is the implementation of the method declared in the parent class.
|
|
*
|
|
* @param string the key identifying the value to be cached
|
|
* @param string the value to be cached
|
|
* @param integer the number of seconds in which the cached value will expire. 0 means never expire.
|
|
* @return boolean true if the value is successfully stored into cache, false otherwise
|
|
*/
|
|
protected function setValue($key,$value,$expire)
|
|
{
|
|
if($expire>0)
|
|
$expire+=time();
|
|
else
|
|
$expire=0;
|
|
|
|
return $this->_cache->set($key,$value,0,$expire);
|
|
}
|
|
|
|
/**
|
|
* Stores a value identified by a key into cache if the cache does not contain this key.
|
|
* This is the implementation of the method declared in the parent class.
|
|
*
|
|
* @param string the key identifying the value to be cached
|
|
* @param string the value to be cached
|
|
* @param integer the number of seconds in which the cached value will expire. 0 means never expire.
|
|
* @return boolean true if the value is successfully stored into cache, false otherwise
|
|
*/
|
|
protected function addValue($key,$value,$expire)
|
|
{
|
|
if($expire>0)
|
|
$expire+=time();
|
|
else
|
|
$expire=0;
|
|
|
|
return $this->_cache->add($key,$value,0,$expire);
|
|
}
|
|
|
|
/**
|
|
* Deletes a value with the specified key from cache
|
|
* This is the implementation of the method declared in the parent class.
|
|
* @param string the key of the value to be deleted
|
|
* @return boolean if no error happens during deletion
|
|
*/
|
|
protected function deleteValue($key)
|
|
{
|
|
return $this->_cache->delete($key);
|
|
}
|
|
|
|
/**
|
|
* Deletes all values from cache.
|
|
* Be careful of performing this operation if the cache is shared by multiple applications.
|
|
*/
|
|
public function flush()
|
|
{
|
|
return $this->_cache->flush();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* CMemCacheServerConfiguration represents the configuration data for a single memcache server.
|
|
*
|
|
* See {@link http://www.php.net/manual/en/function.Memcache-addServer.php}
|
|
* for detailed explanation of each configuration property.
|
|
*
|
|
* @author Qiang Xue <qiang.xue@gmail.com>
|
|
* @version $Id$
|
|
* @package system.caching
|
|
* @since 1.0
|
|
*/
|
|
class CMemCacheServerConfiguration extends CComponent
|
|
{
|
|
/**
|
|
* @var string memcache server hostname or IP address
|
|
*/
|
|
public $host;
|
|
/**
|
|
* @var integer memcache server port
|
|
*/
|
|
public $port=11211;
|
|
/**
|
|
* @var boolean whether to use a persistent connection
|
|
*/
|
|
public $persistent=true;
|
|
/**
|
|
* @var integer probability of using this server among all servers.
|
|
*/
|
|
public $weight=1;
|
|
/**
|
|
* @var integer value in seconds which will be used for connecting to the server
|
|
*/
|
|
public $timeout=15;
|
|
/**
|
|
* @var integer how often a failed server will be retried (in seconds)
|
|
*/
|
|
public $retryInterval=15;
|
|
/**
|
|
* @var boolean if the server should be flagged as online upon a failure
|
|
*/
|
|
public $status=true;
|
|
|
|
/**
|
|
* Constructor.
|
|
* @param array list of memcache server configurations.
|
|
* @throws CException if the configuration is not an array
|
|
*/
|
|
public function __construct($config)
|
|
{
|
|
if(is_array($config))
|
|
{
|
|
foreach($config as $key=>$value)
|
|
$this->$key=$value;
|
|
if($this->host===null)
|
|
throw new CException(Yii::t('yii#CMemCache server configuration must have "host" value.'));
|
|
}
|
|
else
|
|
throw new CException(Yii::t('yii#CMemCache server configuration must be an array.'));
|
|
}
|
|
} |