• Home
• yii
• caching
• Cache

PHP Class yii\caching\Cache

A data item can be stored in the cache by calling Cache::set and be retrieved back later (in the same or different request) by Cache::get. In both operations, a key identifying the data item is required. An expiration time and/or a [[Dependency|dependency]] can also be specified when calling Cache::set. If the data item expires or the dependency changes at the time of calling Cache::get, the cache will return no data. A typical usage pattern of cache is like the following: php $key = 'demo'; $data = $cache->get($key); if ($data === false) { ...generate $data here... $cache->set($key, $data, $duration, $dependency); } Because Cache implements the [[\ArrayAccess]] interface, it can be used like an array. For example, php $cache['foo'] = 'some data'; echo $cache['foo']; Derived classes should implement the following methods which do the actual cache storage operations: - Cache::getValue: retrieve the value with a key (if any) from cache - Cache::setValue: store the value with a key into cache - Cache::addValue: store the value only if the cache does not have this key before - Cache::deleteValue: delete the value with the specified key from cache - Cache::flushValues: delete all values from cache ファイルを表示 Open project: yiisoft/yii2 Class Usage Examples

Public Properties

Property	Type	Description
$defaultDuration		default duration in seconds before a cache entry will expire. Default value is 0, meaning infinity. This value is used by Cache::set if the duration is not explicitly given.
$keyPrefix		a string prefixed to every cache key so that it is unique globally in the whole cache storage. It is recommended that you set a unique cache key prefix for each application if the same cache storage is being used by different applications. To ensure interoperability, only alphanumeric characters should be used.
$serializer		the functions used to serialize and unserialize cached data. Defaults to null, meaning using the default PHP serialize() and unserialize() functions. If you want to use some more efficient serializer (e.g. igbinary), you may configure this property with a two-element array. The first element specifies the serialization function, and the second the deserialization function. If this property is set false, data will be directly sent to and retrieved from the underlying cache component without any serialization or deserialization. You should not turn off serialization if you are using [[Dependency|cache dependency]], because it relies on data serialization. Also, some implementations of the cache can not correctly save and retrieve data different from a string type.

Public Methods

Method	Description
add ( mixed $key, mixed $value, integer $duration, yii\caching\Dependency $dependency = null ) : boolean	Stores a value identified by a key into cache if the cache does not contain this key.
buildKey ( mixed $key ) : string	Builds a normalized cache key from a given key.
delete ( mixed $key ) : boolean	Deletes a value with the specified key from cache
exists ( mixed $key ) : boolean	Checks whether a specified key exists in the cache.
flush ( ) : boolean	Deletes all values from cache.
get ( mixed $key ) : mixed	Retrieves a value from cache with a specified key.
madd ( array $items, integer $duration, yii\caching\Dependency $dependency = null ) : array	Stores multiple items in cache. Each item contains a value identified by a key.
mget ( string[] $keys ) : array	Retrieves multiple values from cache with the specified keys.
mset ( array $items, integer $duration, yii\caching\Dependency $dependency = null ) : array	Stores multiple items in cache. Each item contains a value identified by a key.
multiAdd ( array $items, integer $duration, yii\caching\Dependency $dependency = null ) : array	Stores multiple items in cache. Each item contains a value identified by a key.
multiGet ( string[] $keys ) : array	Retrieves multiple values from cache with the specified keys.
multiSet ( array $items, integer $duration, yii\caching\Dependency $dependency = null ) : array	Stores multiple items in cache. Each item contains a value identified by a key.
offsetExists ( string $key ) : boolean	Returns whether there is a cache entry with a specified key.
offsetGet ( string $key ) : mixed	Retrieves the value from cache with a specified key.
offsetSet ( string $key, mixed $value )	Stores the value identified by a key into cache.
offsetUnset ( string $key )	Deletes the value with the specified key from cache This method is required by the interface [[\ArrayAccess]].
set ( mixed $key, mixed $value, integer $duration = null, yii\caching\Dependency $dependency = null ) : boolean	Stores a value identified by a key into cache.

Protected Methods

Method	Description
addValue ( string $key, mixed $value, integer $duration ) : boolean	Stores a value identified by a key into cache if the cache does not contain this key.
addValues ( array $data, integer $duration ) : array	Adds multiple key-value pairs to cache.
deleteValue ( string $key ) : boolean	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 ( ) : boolean	Deletes all values from cache.
getValue ( string $key ) : mixed | false	Retrieves a value from cache with a specified key.
getValues ( array $keys ) : array	Retrieves multiple values from cache with the specified keys.
setValue ( string $key, mixed $value, integer $duration ) : boolean	Stores a value identified by a key in cache.
setValues ( array $data, integer $duration ) : array	Stores multiple key-value pairs in cache.

Method Details

Property Details