CacheService
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\CacheService » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
- Implements
IApplicationComponent- Since
- 2.0
Class CacheService
See also http://craftcms.com
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $behaviors (opens new window) | array (opens new window) – The behaviors that should be attached to this component. |
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __get() (opens new window) | Returns a property value, an event handler list or a behavior based on its name. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | Sets value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| add() | Stores a value identified by a key into cache if the cache does not contain this key. Nothing will be done if the cache already contains the key. |
| asa() (opens new window) | Returns the named behavior object. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| attachEventHandler() (opens new window) | Attaches an event handler to an event. |
| canGetProperty() (opens new window) | Determines whether a property can be read. |
| canSetProperty() (opens new window) | Determines whether a property can be set. |
| delete() | Deletes a value with the specified key from cache. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| detachEventHandler() (opens new window) | Detaches an existing event handler. |
| disableBehavior() (opens new window) | Disables an attached behavior. |
| disableBehaviors() (opens new window) | Disables all behaviors attached to this component. |
| enableBehavior() (opens new window) | Enables an attached behavior. |
| enableBehaviors() (opens new window) | Enables all behaviors attached to this component. |
| evaluateExpression() (opens new window) | Evaluates a PHP expression or callback under the context of this component. |
| flush() | Deletes all values from cache. Be careful of performing this operation if the cache is shared by multiple applications. |
| get() | Retrieves a value from cache with a specified key. |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| getIsInitialized() (opens new window) | Checks if this application component has been initialized. |
| hasEvent() (opens new window) | Determines whether an event is defined. |
| hasEventHandler() (opens new window) | Checks whether the named event has attached handlers. |
| hasProperty() (opens new window) | Determines whether a property is defined. |
| init() | Do the ole' craft()->cache switcharoo. |
| isInitialized() | Checks if this application component has been initialized yet, or not. |
| mget() | Retrieves multiple values from cache with the specified keys. Some caches (such as memcache, apc) allow retrieving multiple cached values at one time, which may improve the performance since it reduces the communication cost. In case a cache does not support this feature natively, it will be simulated by this method. |
| raiseEvent() (opens new window) | Raises an event. |
| set() | Stores a value identified by a key into cache. If the cache already contains such a key, the existing value and expiration time will be replaced with the new ones. |
# add()
Stores a value identified by a key into cache if the cache does not contain this key. Nothing will be done if the cache already contains the key.
View source (opens new window)
Arguments
$id(string (opens new window)) – The key identifying the value to be cached.$value(mixed) – The value to be cached.$expire(integer (opens new window)) – The number of seconds in which the cached value will expire. 0 means never expire.$dependency(\ICacheDependency) – Dependency of the cached item. If the dependency changes, the item is labeled invalid.
Returns
boolean (opens new window) – True if the value is successfully stored into cache, false otherwise.
Signature
public boolean add ( $id, $value, $expire = null, $dependency = null )
# delete()
Deletes a value with the specified key from cache.
View source (opens new window)
Arguments
$id(string (opens new window)) – The key of the value to be deleted.
Returns
boolean (opens new window) – If no error happens during deletion.
Signature
public boolean delete ( $id )
# flush()
Deletes all values from cache. Be careful of performing this operation if the cache is shared by multiple applications.
View source (opens new window)
Returns
boolean (opens new window) – Whether the flush operation was successful.
Signature
public boolean flush ( )
# get()
Retrieves a value from cache with a specified key.
View source (opens new window)
Arguments
$id(string (opens new window)) – A key identifying the cached value
Returns
mixed – The value stored in cache, false if the value is not in the cache, expired if the dependency has
changed.
Signature
public mixed get ( $id )
# init()
Signature
public null init ( )
# mget()
Retrieves multiple values from cache with the specified keys. Some caches (such as memcache, apc) allow retrieving multiple cached values at one time, which may improve the performance since it reduces the communication cost. In case a cache does not support this feature natively, it will be simulated by this method.
View source (opens new window)
Arguments
$ids(array (opens new window)) – The list of keys identifying the cached values
Returns
array (opens new window) – The list of cached values corresponding to the specified keys. The array is returned in terms of (key,value) pairs. If a value is not cached or expired, the corresponding array value will be false.
Signature
public array mget ( $ids )
# set()
Stores a value identified by a key into cache. If the cache already contains such a key, the existing value and expiration time will be replaced with the new ones.
View source (opens new window)
Arguments
$id(string (opens new window)) – The key identifying the value to be cached.$value(mixed) – The value to be cached.$expire(integer (opens new window)) – The number of seconds in which the cached value will expire. Pass0to have the value never expire, andnullto use the ‘cacheDuration’ config setting. (Default value isnull.)$dependency(\ICacheDependency) – Dependency of the cached item. If the dependency changes, the item is labeled invalid.
Returns
boolean (opens new window) – True if the value is successfully stored into cache, false otherwise.
Signature
public boolean set ( $id, $value, $expire = null, $dependency = null )