DummyCache

API reference › yii › caching › DummyCache

class	`yii\caching\DummyCache`
Extends	`Cache` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`CacheInterface`, `yii\base\Configurable`
Since	2.0
Source	`framework/caching/DummyCache.php`

DummyCache is a placeholder cache component.

DummyCache does not cache anything. It is provided so that one can always configure a ‘cache’ application component and save the check of existence of \Yii::$app->cache. By replacing DummyCache with some other cache component, one can quickly switch from non-caching mode to caching mode.

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

Properties

Property	Type	Description	Defined by
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$defaultDuration`	`int`	Default duration in seconds before a cache entry will expire. Default: `0`. Available since 2.0.11.	`Cache`
`$keyPrefix`	`string`	A string prefixed to every cache key so that it is unique globally in the whole cache storage. Default: `null`.	`Cache`
`$serializer`	`array\|null\|false`	The functions used to serialize and unserialize cached data. Default: `null`.	`Cache`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\Component`
`__clone()`	This method is called after the object is created by cloning an existing one.	`yii\base\Component`
`__get()`	Returns the value of a component property.	`yii\base\Component`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\Component`
`__set()`	Sets the value of a component property.	`yii\base\Component`
`__unset()`	Sets a component property to be null.	`yii\base\Component`
`add()`	Stores a value identified by a key into cache if the cache does not contain this key.	`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.	`Cache`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\Component`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\Component`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`delete()`	Deletes a value with the specified key from cache.	`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.	`Cache`
`flush()`	Deletes all values from cache.	`Cache`
`get()`	Retrieves a value from cache with a specified key.	`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.	`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\Component`
`hasProperty()`	Returns a value indicating whether a property is defined for this component.	`yii\base\Component`
`init()`	Initializes the object.	`Cache`
`multiAdd()`	Stores multiple items in cache. Each item contains a value identified by a key.	`Cache`
`multiGet()`	Retrieves multiple values from cache with the specified keys.	`Cache`
`multiSet()`	Stores multiple items in cache. Each item contains a value identified by a key.	`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.	`Cache`
`offsetGet()`	Retrieves the value from cache with a specified key.	`Cache`
`offsetSet()`	Stores the value identified by a key into cache.	`Cache`
`offsetUnset()`	Deletes the value with the specified key from cache This method is required by the interface `ArrayAccess`.	`Cache`
`on()`	Attaches an event handler to an event.	`yii\base\Component`
`set()`	Stores a value identified by a key into cache.	`Cache`
`trigger()`	Triggers an event.	`yii\base\Component`
`addValue()` protected	Stores a value identified by a key into cache if the cache does not contain this key.	`DummyCache`
`addValues()` protected	Adds multiple key-value pairs to cache.	`Cache`
`deleteValue()` protected	Deletes a value with the specified key from cache This is the implementation of the method declared in the parent class.	`DummyCache`
`flushValues()` protected	Deletes all values from cache.	`DummyCache`
`getValue()` protected	Retrieves a value from cache with a specified key.	`DummyCache`
`getValues()` protected	Retrieves multiple values from cache with the specified keys.	`Cache`
`setValue()` protected	Stores a value identified by a key in cache.	`DummyCache`
`setValues()` protected	Stores multiple key-value pairs in cache.	`Cache`

Method details

addValue()

protected function addValue(string $key, mixed $value, int $duration): bool

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

This is the implementation of the method declared in the parent class.

Parameters

Parameter	Type	Description
`$key`	`string`	The key identifying the value to be cached
`$value`	`mixed`	The value to be cached
`$duration`	`int`	The number of seconds in which the cached value will expire. 0 means never expire.

Returns

bool: True if the value is successfully stored into cache, false otherwise

deleteValue()

protected function deleteValue(string $key): bool

Deletes a value with the specified key from cache This is the implementation of the method declared in the parent class.

Parameters

Parameter	Type	Description
`$key`	`string`	The key of the value to be deleted

Returns

bool: If no error happens during deletion

flushValues()

protected function flushValues(): bool

Deletes all values from cache.

This is the implementation of the method declared in the parent class.

Returns

bool: Whether the flush operation was successful.

getValue()

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

Retrieves a value from cache with a specified key.

This is the implementation of the method declared in the parent class.

Parameters

Parameter	Type	Description
`$key`	`string`	A unique key identifying the cached value

Returns

mixed|false: The value stored in cache, false if the value is not in the cache or expired.

setValue()

protected function setValue(string $key, mixed $value, int $duration): bool

Stores a value identified by a key in cache.

This is the implementation of the method declared in the parent class.

Parameters

Parameter	Type	Description
`$key`	`string`	The key identifying the value to be cached
`$value`	`mixed`	The value to be cached
`$duration`	`int`	The number of seconds in which the cached value will expire. 0 means never expire.

Returns

bool: True if the value is successfully stored into cache, false otherwise