Class yii\caching\ZendDataCache
| Inheritance | yii\caching\ZendDataCache » yii\caching\Cache » yii\base\Component » yii\base\Object |
|---|---|
| Implements | ArrayAccess, yii\base\Configurable |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2/blob/master/framework/caching/ZendDataCache.php |
ZendDataCache provides Zend data caching in terms of an application component.
To use this application component, the Zend Data Cache PHP extension must be loaded.
See yii\caching\Cache for common cache operations that ZendDataCache supports.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component | yii\base\Component |
| $keyPrefix | string | A string prefixed to every cache key so that it is unique globally in the whole cache storage. | yii\caching\Cache |
| $serializer | array|boolean | 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\Cache |
| 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 |
| 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 |
| 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\ZendDataCache |
| addValues() | Adds multiple key-value pairs to cache. | yii\caching\Cache |
| deleteValue() | Deletes a value with the specified key from cache This is the implementation of the method declared in the parent class. | yii\caching\ZendDataCache |
| flushValues() | Deletes all values from cache. | yii\caching\ZendDataCache |
| getValue() | Retrieves a value from cache with a specified key. | yii\caching\ZendDataCache |
| 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\ZendDataCache |
| setValues() | Stores multiple key-value pairs in cache. | yii\caching\Cache |
Method Details
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.
| boolean addValue( $key, $value, $duration ) | ||
| $key | string | The key identifying the value to be cached |
| $value | string | The value to be cached |
| $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 |
|---|---|---|
Deletes a value with the specified key from cache This is the implementation of the method declared in the parent class.
| boolean deleteValue( $key ) | ||
| $key | string | The key of the value to be deleted |
| return | boolean | If no error happens during deletion |
|---|---|---|
Deletes all values from cache.
This is the implementation of the method declared in the parent class.
| boolean flushValues( ) | ||
| return | boolean | Whether the flush operation was successful. |
|---|---|---|
Retrieves a value from cache with a specified key.
This is the implementation of the method declared in the parent class.
| string|boolean getValue( $key ) | ||
| $key | string | A unique key identifying the cached value |
| return | string|boolean | The value stored in cache, false if the value is not in the cache or expired. |
|---|---|---|
Stores a value identified by a key in cache.
This is the implementation of the method declared in the parent class.
| boolean setValue( $key, $value, $duration ) | ||
| $key | string | The key identifying the value to be cached |
| $value | string | The value to be cached |
| $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 |
|---|---|---|