CacheService

Type
Class
Namespace
Craft
Inherits
Craft\CacheService » Craft\BaseApplicationComponent » CApplicationComponent » CComponent
Implements
IApplicationComponent
Since
2.0

Class CacheService

See also http://craftcms.com

View source

Public Properties

PropertyDescription
$behaviorsarray – The behaviors that should be attached to this component.

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__get()Returns a property value, an event handler list or a behavior based on its name.
__isset()Checks if a property value is null.
__set()Sets value of a component property.
__unset()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()Returns the named behavior object.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
canGetProperty()Determines whether a property can be read.
canSetProperty()Determines whether a property can be set.
delete()Deletes a value with the specified key from cache.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
evaluateExpression()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()Returns the list of attached event handlers for an event.
getIsInitialized()Checks if this application component has been initialized.
hasEvent()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()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()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

Arguments

  • $id (string) – The key identifying the value to be cached.
  • $value (mixed) – The value to be cached.
  • $expire (integer) – 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 – 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

Arguments

  • $id (string) – The key of the value to be deleted.

Returns

boolean – 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

Returns

boolean – Whether the flush operation was successful.

Signature

public boolean flush ( )

get()

Retrieves a value from cache with a specified key.

View source

Arguments

  • $id (string) – 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()

Do the ole' craft()->cache switcharoo.

View source

Returns

null

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

Arguments

  • $ids (array) – The list of keys identifying the cached values

Returns

array – 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

Arguments

  • $id (string) – The key identifying the value to be cached.
  • $value (mixed) – The value to be cached.
  • $expire (integer) – The number of seconds in which the cached value will expire. Pass 0 to have the value never expire, and null to use the ‘cacheDuration’ config setting. (Default value is null.)
  • $dependency (\ICacheDependency) – Dependency of the cached item. If the dependency changes, the item is labeled invalid.

Returns

boolean – True if the value is successfully stored into cache, false otherwise.

Signature

public boolean set ( $id, $value, $expire = null, $dependency = null )