W3cubDocs

/Yii 2.0

Class yii\caching\ArrayCache

Inheritance yii\caching\ArrayCache » yii\caching\Cache » yii\base\Component » yii\base\Object
Implements yii\base\Configurable, yii\caching\CacheInterface
Available since version 2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/caching/ArrayCache.php

ArrayCache provides caching for the current request only by storing the values in an array.

See yii\caching\Cache for common cache operations that ArrayCache supports.

Unlike the yii\caching\Cache, ArrayCache allows the expire parameter of set(), add(), multiSet() and multiAdd() to be a floating point number, so you may specify the time in milliseconds (e.g. 0.1 will be 100 milliseconds).

For enhanced performance of ArrayCache, you can disable serialization of the stored data by setting $serializer to false.

For more details and usage information on Cache, see the guide article on caching.

Public Properties

Property Type Description Defined By
$behaviors yii\base\Behavior[] List of behaviors attached to this component yii\base\Component
$defaultDuration integer Default duration in seconds before a cache entry will expire. yii\caching\Cache
$keyPrefix string A string prefixed to every cache key so that it is unique globally in the whole cache storage. yii\caching\Cache
$serializer null|array|false The functions used to serialize and unserialize cached data. yii\caching\Cache

Public Methods

Method Description Defined By
__call() Calls the named method which is not a class method. yii\base\Object
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\Object
__get() Returns the value of an object property. yii\base\Object
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Object
__set() Sets value of an object property. yii\base\Object
__unset() Sets an object property to null. yii\base\Object
add() Stores a value identified by a key into cache if the cache does not contain this key. yii\caching\Cache
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
buildKey() Builds a normalized cache key from a given key. yii\caching\Cache
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Object
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Object
className() Returns the fully qualified name of this class. yii\base\Object
delete() Deletes a value with the specified key from cache yii\caching\Cache
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
exists() Checks whether a specified key exists in the cache. yii\caching\ArrayCache
flush() Deletes all values from cache. yii\caching\Cache
get() Retrieves a value from cache with a specified key. yii\caching\Cache
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getOrSet() Method combines both set() and get() methods to retrieve value identified by a $key, or to store the result of $callable execution if there is no cache available for the $key. yii\caching\Cache
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\Object
hasProperty() Returns a value indicating whether a property is defined. yii\base\Object
init() Initializes the object. yii\base\Object
madd() Stores multiple items in cache. Each item contains a value identified by a key. yii\caching\Cache
mget() Retrieves multiple values from cache with the specified keys. yii\caching\Cache
mset() Stores multiple items in cache. Each item contains a value identified by a key. yii\caching\Cache
multiAdd() Stores multiple items in cache. Each item contains a value identified by a key. yii\caching\Cache
multiGet() Retrieves multiple values from cache with the specified keys. yii\caching\Cache
multiSet() Stores multiple items in cache. Each item contains a value identified by a key. yii\caching\Cache
off() Detaches an existing event handler from this component. yii\base\Component
offsetExists() Returns whether there is a cache entry with a specified key. yii\caching\Cache
offsetGet() Retrieves the value from cache with a specified key. yii\caching\Cache
offsetSet() Stores the value identified by a key into cache. yii\caching\Cache
offsetUnset() Deletes the value with the specified key from cache This method is required by the interface ArrayAccess. yii\caching\Cache
on() Attaches an event handler to an event. yii\base\Component
set() Stores a value identified by a key into cache. yii\caching\Cache
trigger() Triggers an event. yii\base\Component

Protected Methods

Method Description Defined By
addValue() Stores a value identified by a key into cache if the cache does not contain this key. yii\caching\ArrayCache
addValues() Adds multiple key-value pairs to cache. yii\caching\Cache
deleteValue() 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. yii\caching\ArrayCache
flushValues() Deletes all values from cache. yii\caching\ArrayCache
getValue() Retrieves a value from cache with a specified key. yii\caching\ArrayCache
getValues() Retrieves multiple values from cache with the specified keys. yii\caching\Cache
setValue() Stores a value identified by a key in cache. yii\caching\ArrayCache
setValues() Stores multiple key-value pairs in cache. yii\caching\Cache

Method Details

addValue() protected method

Stores a value identified by a key into cache if the cache does not contain this key.

This method should be implemented by child classes to store the data in specific cache storage.

protected boolean addValue ( $key, $value, $duration )
$key string

The key identifying the value to be cached

$value mixed

The value to be cached. Most often it's a string. If you have disabled $serializer, it could be something else.

$duration 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

deleteValue() protected method

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.

protected boolean deleteValue ( $key )
$key string

The key of the value to be deleted

return boolean

If no error happens during deletion

exists() public method

Checks whether a specified key exists in the cache.

This can be faster than getting the value from the cache if the data is big. In case a cache does not support this feature natively, this method will try to simulate it but has no performance improvement over getting it. Note that this method does not check whether the dependency associated with the cached data, if there is any, has changed. So a call to get() may return false while exists returns true.

public boolean exists ( $key )
$key mixed

A key identifying the cached value. This can be a simple string or a complex data structure consisting of factors representing the key.

return boolean

True if a value exists in cache, false if the value is not in the cache or expired.

flushValues() protected method

Deletes all values from cache.

Child classes may implement this method to realize the flush operation.

protected boolean flushValues ( )
return boolean

Whether the flush operation was successful.

getValue() protected method

Retrieves a value from cache with a specified key.

This method should be implemented by child classes to retrieve the data from specific cache storage.

protected mixed|false getValue ( $key )
$key string

A unique key identifying the cached value

return mixed|false

The value stored in cache, false if the value is not in the cache or expired. Most often value is a string. If you have disabled $serializer, it could be something else.

setValue() protected method

Stores a value identified by a key in cache.

This method should be implemented by child classes to store the data in specific cache storage.

protected boolean setValue ( $key, $value, $duration )
$key string

The key identifying the value to be cached

$value mixed

The value to be cached. Most often it's a string. If you have disabled $serializer, it could be something else.

$duration 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

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-caching-arraycache.html