CEAcceleratorCache
CEAcceleratorCache implements a cache application module based on
eaccelerator.
To use this application component, the eAccelerator PHP extension must be loaded.
See
CCache manual for common cache operations that are supported by CEAccelerator.
Please note that as of v0.9.6, eAccelerator no longer supports data caching. This means if you still want to use this component, your eAccelerator should be of 0.9.5.x or lower version.
Protected Methods
Method |
Description |
Defined By |
addValue() | Stores a value identified by a key into cache if the cache does not contain this key. | CEAcceleratorCache |
deleteValue() | Deletes a value with the specified key from cache | CEAcceleratorCache |
flushValues() | Deletes all values from cache. | CEAcceleratorCache |
generateUniqueKey() | | CCache |
getValue() | Retrieves a value from cache with a specified key. | CEAcceleratorCache |
getValues() | Retrieves multiple values from cache with the specified keys. | CCache |
setValue() | Stores a value identified by a key in cache. | CEAcceleratorCache |
Method Details
protected boolean addValue(string $key, string $value, integer $expire) |
$key | string | the key identifying the value to be cached |
$value | string | the value to be cached |
$expire | 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 |
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.
protected boolean deleteValue(string $key) |
$key | string | the key of the value to be deleted |
{return} | boolean | if no error happens during deletion |
Deletes a value with the specified key from cache This is the implementation of the method declared in the parent class.
protected boolean flushValues() |
{return} | boolean | whether the flush operation was successful. |
Source Code: framework/caching/CEAcceleratorCache.php#96 (
show)
protected function flushValues()
{
// first, remove expired content from cache
eaccelerator_gc();
// now, remove leftover cache-keys
$keys = eaccelerator_list_keys();
foreach($keys as $key)
$this->deleteValue(substr($key['name'], 1));
return true;
}
Deletes all values from cache. This is the implementation of the method declared in the parent class.
protected string|boolean getValue(string $key) |
$key | string | a unique key identifying the cached value |
{return} | string|boolean | the value stored in cache, false if the value is not in the cache or expired. |
Retrieves a value from cache with a specified key. This is the implementation of the method declared in the parent class.
Source Code: framework/caching/CEAcceleratorCache.php#32 (
show)
public function init()
{
parent::init();
if(!function_exists('eaccelerator_get'))
throw new CException(Yii::t('yii','CEAcceleratorCache requires PHP eAccelerator extension to be loaded, enabled or compiled with the "--with-eaccelerator-shared-memory" option.'));
}
Initializes this application component. This method is required by the IApplicationComponent interface. It checks the availability of eAccelerator.
protected boolean setValue(string $key, string $value, integer $expire) |
$key | string | the key identifying the value to be cached |
$value | string | the value to be cached |
$expire | 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 |
Stores a value identified by a key in cache. This is the implementation of the method declared in the parent class.