CApcCache
| Package | system.caching |
|---|---|
| Inheritance | class CApcCache » CCache » CApplicationComponent » CComponent |
| Implements | ArrayAccess, ICache, IApplicationComponent |
| Since | 1.0 |
| Version | $Id: CApcCache.php 3515 2011-12-28 12:29:24Z mdomba $ |
| Source Code | framework/caching/CApcCache.php |
CApcCache provides APC caching in terms of an application component.
The caching is based on APC. To use this application component, the APC PHP extension must be loaded.
See CCache manual for common cache operations that are supported by CApcCache.
The caching is based on APC. To use this application component, the APC PHP extension must be loaded.
See CCache manual for common cache operations that are supported by CApcCache.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| behaviors | array | the behaviors that should be attached to this component. | CApplicationComponent |
| isInitialized | boolean | Checks if this application component bas been initialized. | CApplicationComponent |
| keyPrefix | string | a string prefixed to every cache key so that it is unique. | 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 bas 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. | CApcCache |
| 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. | CApcCache |
| deleteValue() | Deletes a value with the specified key from cache | CApcCache |
| flushValues() | Deletes all values from cache. | CApcCache |
| generateUniqueKey() | CCache | |
| getValue() | Retrieves a value from cache with a specified key. | CApcCache |
| getValues() | Retrieves multiple values from cache with the specified keys. | CApcCache |
| setValue() | Stores a value identified by a key in cache. | CApcCache |
Method Details
addValue()
method
|
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 |
Source Code: framework/caching/CApcCache.php#83 (show)
protected function addValue($key,$value,$expire)
{
return apc_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
|
protected boolean deleteValue(string $key)
| ||
| $key | string | the key of the value to be deleted |
| {return} | boolean | if no error happens during deletion |
Source Code: framework/caching/CApcCache.php#94 (show)
protected function deleteValue($key)
{
return apc_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)
|
protected boolean flushValues()
| ||
| {return} | boolean | whether the flush operation was successful. |
Source Code: framework/caching/CApcCache.php#105 (show)
protected function flushValues()
{
return apc_clear_cache('user');
}
Deletes all values from cache. This is the implementation of the method declared in the parent class.
getValue()
method
|
protected string getValue(string $key)
| ||
| $key | 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. |
Source Code: framework/caching/CApcCache.php#45 (show)
protected function getValue($key)
{
return apc_fetch($key);
}
Retrieves a value from cache with a specified key. This is the implementation of the method declared in the parent class.
getValues()
method
|
protected array getValues(array $keys)
| ||
| $keys | array | a list of keys identifying the cached values |
| {return} | array | a list of cached values indexed by the keys |
Source Code: framework/caching/CApcCache.php#55 (show)
protected function getValues($keys)
{
return apc_fetch($keys);
}
Retrieves multiple values from cache with the specified keys.
init()
method
|
public void init()
|
Source Code: framework/caching/CApcCache.php#32 (show)
public function init()
{
parent::init();
if(!extension_loaded('apc'))
throw new CException(Yii::t('yii','CApcCache requires PHP apc extension to be loaded.'));
}
Initializes this application component. This method is required by the IApplicationComponent interface. It checks the availability of memcache.
setValue()
method
|
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 |
Source Code: framework/caching/CApcCache.php#69 (show)
protected function setValue($key,$value,$expire)
{
return apc_store($key,$value,$expire);
}
Stores a value identified by a key in cache. This is the implementation of the method declared in the parent class.