PHP Class yii\caching\ApcCache

To use this application component, the APC PHP extension must be loaded. Alternatively APCu PHP extension could be used via setting useApcu to true. In order to enable APC or APCu for CLI you should add "apc.enable_cli = 1" to your php.ini. See Cache for common cache operations that ApcCache supports. For more details and usage information on Cache, see the guide article on caching.
Since: 2.0
Author: Qiang Xue ([email protected])
Inheritance: extends Cache
Afficher le fichier Open project: yiisoft/yii2 Class Usage Examples

Méthodes publiques

Свойство Type Description
$useApcu whether to use apcu or apc as the underlying caching extension. If true, apcu will be used. If false, apc will be used. Defaults to false.

Méthodes publiques

Méthode Description
exists ( mixed $key ) : boolean Checks whether a specified key exists in the cache.
init ( ) Initializes this application component.

Méthodes protégées

Méthode 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 is the implementation of the method declared in the parent class.
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

addValue() protected méthode

This is the implementation of the method declared in the parent class.
protected addValue ( string $key, mixed $value, integer $duration ) : boolean
$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.
Résultat boolean true if the value is successfully stored into cache, false otherwise

addValues() protected méthode

Adds multiple key-value pairs to cache.
protected addValues ( array $data, integer $duration ) : array
$data array array where key corresponds to cache key while value is the value stored
$duration integer the number of seconds in which the cached values will expire. 0 means never expire.
Résultat array array of failed keys

deleteValue() protected méthode

Deletes a value with the specified key from cache This is the implementation of the method declared in the parent class.
protected deleteValue ( string $key ) : boolean
$key string the key of the value to be deleted
Résultat boolean if no error happens during deletion

exists() public méthode

This can be faster than getting the value from the cache if the data is big. 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 exists ( mixed $key ) : boolean
$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.
Résultat boolean true if a value exists in cache, false if the value is not in the cache or expired.

flushValues() protected méthode

This is the implementation of the method declared in the parent class.
protected flushValues ( ) : boolean
Résultat boolean whether the flush operation was successful.

getValue() protected méthode

This is the implementation of the method declared in the parent class.
protected getValue ( string $key ) : mixed | false
$key string a unique key identifying the cached value
Résultat mixed | false the value stored in cache, false if the value is not in the cache or expired.

getValues() protected méthode

Retrieves multiple values from cache with the specified keys.
protected getValues ( array $keys ) : array
$keys array a list of keys identifying the cached values
Résultat array a list of cached values indexed by the keys

init() public méthode

It checks if extension required is loaded.
public init ( )

setValue() protected méthode

This is the implementation of the method declared in the parent class.
protected setValue ( string $key, mixed $value, integer $duration ) : boolean
$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.
Résultat boolean true if the value is successfully stored into cache, false otherwise.

setValues() protected méthode

Stores multiple key-value pairs in cache.
protected setValues ( array $data, integer $duration ) : array
$data array array where key corresponds to cache key while value
$duration integer the number of seconds in which the cached values will expire. 0 means never expire.
Résultat array array of failed keys

Property Details

$useApcu public_oe property

whether to use apcu or apc as the underlying caching extension. If true, apcu will be used. If false, apc will be used. Defaults to false.
Since: 2.0.7
public $useApcu