FileCache

Type
Class
Namespace
Craft
Inherits
Craft\FileCache » CFileCache (opens new window) » CCache (opens new window) » CApplicationComponent (opens new window) » CComponent (opens new window)
Implements
ArrayAccess (opens new window), IApplicationComponent, ICache
Since
1.0

Class FileCache

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.
$cacheFileMode (opens new window) integer (opens new window) – The permission to be set for new cache files.
$cacheFileSuffix (opens new window) string (opens new window) – Cache file suffix.
$cachePath (opens new window) string (opens new window) – The directory to store cache files.
$cachePathMode (opens new window) integer (opens new window) – The permission to be set for directory to store cache files This value will be used by PHP chmod function.
$directoryLevel (opens new window) integer (opens new window) – The level of sub-directories to store cache files.
$embedExpiry (opens new window) boolean (opens new window) – Whether cache entry expiration time should be embedded into a physical file.
$hashKey (opens new window) boolean (opens new window) – Whether to md5-hash the cache key for normalization purposes.
$keyPrefix (opens new window) string (opens new window) – A string prefixed to every cache key so that it is unique.
$serializer (opens new window) array (opens new window), boolean (opens new window) – The functions used to serialize and unserialize cached data.

# 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() (opens new window) 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() (opens new window) Deletes all values from cache.
gc() (opens new window) Removes expired cache files.
get() (opens new window) Retrieves a value from cache with a specified key.
getEventHandlers() (opens new window) Returns the list of attached event handlers for an event.
getGCProbability() (opens new window)
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() Override so we can set a custom file cache path.
mget() (opens new window) Retrieves multiple values from cache with the specified keys.
offsetExists() (opens new window) Returns whether there is a cache entry with a specified key.
offsetGet() (opens new window) Retrieves the value from cache with a specified key.
offsetSet() (opens new window) Stores the value identified by a key into cache.
offsetUnset() (opens new window) Deletes the value with the specified key from cache This method is required by the interface ArrayAccess.
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.
setGCProbability() (opens new window)

# 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 )

# init()

Override so we can set a custom file cache path.

View source (opens new window)

Returns

null (opens new window)

Signature

public null init ( )

# 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. 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 set ( $id, $value, $expire = null, $dependency = null )

# Protected Methods

Method Description
addValue() (opens new window) Stores a value identified by a key into cache if the cache does not contain this key.
deleteValue() (opens new window) Deletes a value with the specified key from cache This method should be implemented by child classes to delete the data from actual cache storage.
flushValues() (opens new window) Deletes all values from cache.
generateUniqueKey() (opens new window)
getCacheFile() (opens new window) Returns the cache file path given the cache key.
getValue() (opens new window) Retrieves a value from cache with a specified key.
getValues() (opens new window) Retrieves multiple values from cache with the specified keys.
setValue() Stores a value identified by a key in cache. This is the implementation of the method declared in the parent class.

# setValue()

Stores a value identified by a key in cache. This is the implementation of the method declared in the parent class.

View source (opens new window)

Arguments

Returns

boolean (opens new window) – True if the value is successfully stored into cache, false otherwise.

Signature

protected boolean setValue ( $key, $value, $expire )