On this page
CWinCache
| Package | system.caching |
|---|---|
| Inheritance | class CWinCache » CCache » CApplicationComponent » CComponent |
| Implements | ArrayAccess, ICache, IApplicationComponent |
| Since | 1.1.2 |
| Source Code | framework/caching/CWinCache.php |
To use this application component, the WinCache PHP extension must be loaded.
See CCache manual for common cache operations that are supported by CWinCache.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| behaviors | array | the behaviors that should be attached to this component. | CApplicationComponent |
| hashKey | boolean | whether to md5-hash the cache key for normalization purposes. | CCache |
| isInitialized | boolean | Checks if this application component has been initialized. | CApplicationComponent |
| keyPrefix | string | a string prefixed to every cache key so that it is unique. | CCache |
| serializer | array|boolean | the functions used to serialize and unserialize cached data. | CCache |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __get() | Returns a property value, an event handler list or a behavior based on its name. | CComponent |
| __isset() | Checks if a property value is null. | CComponent |
| __set() | Sets value of a component property. | CComponent |
| __unset() | Sets a component property to be null. | CComponent |
| add() | Stores a value identified by a key into cache if the cache does not contain this key. | CCache |
| asa() | Returns the named behavior object. | CComponent |
| attachBehavior() | Attaches a behavior to this component. | CComponent |
| attachBehaviors() | Attaches a list of behaviors to the component. | CComponent |
| attachEventHandler() | Attaches an event handler to an event. | CComponent |
| canGetProperty() | Determines whether a property can be read. | CComponent |
| canSetProperty() | Determines whether a property can be set. | CComponent |
| delete() | Deletes a value with the specified key from cache | CCache |
| detachBehavior() | Detaches a behavior from the component. | CComponent |
| detachBehaviors() | Detaches all behaviors from the component. | CComponent |
| detachEventHandler() | Detaches an existing event handler. | CComponent |
| disableBehavior() | Disables an attached behavior. | CComponent |
| disableBehaviors() | Disables all behaviors attached to this component. | CComponent |
| enableBehavior() | Enables an attached behavior. | CComponent |
| enableBehaviors() | Enables all behaviors attached to this component. | CComponent |
| evaluateExpression() | Evaluates a PHP expression or callback under the context of this component. | CComponent |
| flush() | Deletes all values from cache. | CCache |
| get() | Retrieves a value from cache with a specified key. | CCache |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getIsInitialized() | Checks if this application component has been initialized. | CApplicationComponent |
| hasEvent() | Determines whether an event is defined. | CComponent |
| hasEventHandler() | Checks whether the named event has attached handlers. | CComponent |
| hasProperty() | Determines whether a property is defined. | CComponent |
| init() | Initializes this application component. | CWinCache |
| mget() | Retrieves multiple values from cache with the specified keys. | CCache |
| offsetExists() | Returns whether there is a cache entry with a specified key. | CCache |
| offsetGet() | Retrieves the value from cache with a specified key. | CCache |
| offsetSet() | Stores the value identified by a key into cache. | CCache |
| offsetUnset() | Deletes the value with the specified key from cache | CCache |
| raiseEvent() | Raises an event. | CComponent |
| set() | Stores a value identified by a key into cache. | CCache |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| addValue() | Stores a value identified by a key into cache if the cache does not contain this key. | CWinCache |
| deleteValue() | Deletes a value with the specified key from cache | CWinCache |
| flushValues() | Deletes all values from cache. | CWinCache |
| generateUniqueKey() | CCache | |
| getValue() | Retrieves a value from cache with a specified key. | CWinCache |
| getValues() | Retrieves multiple values from cache with the specified keys. | CWinCache |
| setValue() | Stores a value identified by a key in cache. | CWinCache |
Method Details
addValue() method
|
||
| $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 |
protected function addValue($key,$value,$expire)
{
return wincache_ucache_add($key,$value,$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.
deleteValue() method
|
||
| $key | string | the key of the value to be deleted |
| {return} | boolean | if no error happens during deletion |
protected function deleteValue($key)
{
return wincache_ucache_delete($key);
}
Deletes a value with the specified key from cache This is the implementation of the method declared in the parent class.
flushValues() method (available since v1.1.5)
|
||
| {return} | boolean | whether the flush operation was successful. |
protected function flushValues()
{
return wincache_ucache_clear();
}
Deletes all values from cache. This is the implementation of the method declared in the parent class.
getValue() method
|
||
| $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. |
protected function getValue($key)
{
return wincache_ucache_get($key);
}
Retrieves a value from cache with a specified key. This is the implementation of the method declared in the parent class.
getValues() method
|
||
| $keys | array | a list of keys identifying the cached values |
| {return} | array | a list of cached values indexed by the keys |
protected function getValues($keys)
{
return wincache_ucache_get($keys);
}
Retrieves multiple values from cache with the specified keys.
init() method
|
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.'));
}
Initializes this application component. This method is required by the IApplicationComponent interface. It checks the availability of WinCache extension and WinCache user cache.
setValue() method
|
||
| $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 |
protected function setValue($key,$value,$expire)
{
return wincache_ucache_set($key,$value,$expire);
}
Stores a value identified by a key in cache. This is the implementation of the method declared in the parent class.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CWinCache