Storage engine for CakePHP caching
$_defaultConfig protected arrayThe default cache configuration is overridden in most cache adapters. These are the keys that are common to all adapters. If overridden, this property is not used.
$_groupPrefix protected stringContains the compiled string with all groups prefixes to be prepended to every key in this cache engine
Clears all values belonging to a group. Is up to the implementing engine to decide whether actually delete the keys or just simulate it to achieve the same result.
Does whatever initialization for each group is required and returns the group value for each of them, this is the token representing each group in the cache key
_key( string $key )
Generates a safe key, taking account of the configured key prefix
$key add( string $key , mixed $value )
Add a key to the cache if it does not already exist.
Defaults to a non-atomic implementation. Subclasses should prefer atomic implementations.
$key $value clear( boolean $check )
Delete all keys from the cache
$check clearGroup( string $group )
Clears all values belonging to a group. Is up to the implementing engine to decide whether actually delete the keys or just simulate it to achieve the same result.
$group decrement( string $key , integer $offset 1 )
Decrement a number under the key and return decremented value
$key $offset optional 1 delete( string $key )
Delete a key from the cache
$key deleteMany( array $keys )
Deletes keys from the cache
$keys For each provided cache key (given back as the array key) true if the value was successfully deleted, false if it didn't exist or couldn't be removed
gc( integer|null $expires null )
Garbage collection
Permanently remove all expired and deleted data
$expires optional null groups( )
Does whatever initialization for each group is required and returns the group value for each of them, this is the token representing each group in the cache key
increment( string $key , integer $offset 1 )
Increment a number under the key and return incremented value
$key $offset optional 1 init( array $config [] )
Initialize the cache engine
Called automatically by the cache frontend. Merge the runtime config with the defaults before use.
$config optional [] key( string $key )
Generates a safe key for use with cache engine storage engines.
$key read( string $key )
Read a key from the cache
$key readMany( array $keys )
Read multiple keys from the cache
$keys For each cache key (given as the array key) the cache data associated or false if the data doesn't exist, has expired, or if there was an error fetching it
write( string $key , mixed $value )
Write value for a key into cache
$key $value writeMany( array $data )
Write data for many keys into cache
$data _configDelete( string $key )
Deletes a single config key.
$key Cake\Core\Exception\Exception_configRead( string|null $key )
Reads a config key.
$key _configWrite( string|array $key , mixed $value , boolean|string $merge false )
Writes a config key.
$key $value $merge optional false True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Cake\Core\Exception\Exceptionconfig( string|array|null $key null , mixed|null $value null , boolean $merge true )
Gets/Sets the config.
Reading the whole config:
$this->config();
Reading a specific value:
$this->config('key'); Reading a nested value:
$this->config('some.nested.key'); Setting a specific value:
$this->config('key', $value); Setting a nested value:
$this->config('some.nested.key', $value); Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);
$key optional null $value optional null $merge optional true Cake\Core\Exception\ExceptionconfigShallow( string|array $key , mixed|null $value null )
Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
Setting a specific value:
$this->config('key', $value); Setting a nested value:
$this->config('some.nested.key', $value); Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);
$key $value optional null getConfig( string|null $key null )
Returns the config.
Reading the whole config:
$this->getConfig();
Reading a specific value:
$this->getConfig('key'); Reading a nested value:
$this->getConfig('some.nested.key'); $key optional null setConfig( string|array $key , mixed|null $value null , boolean $merge true )
Sets the config.
Setting a specific value:
$this->setConfig('key', $value); Setting a nested value:
$this->setConfig('some.nested.key', $value); Updating multiple config settings at the same time:
$this->setConfig(['one' => 'value', 'another' => 'value']);
$key $value optional null $merge optional true Cake\Core\Exception\Exceptionprotected array
The default cache configuration is overridden in most cache adapters. These are the keys that are common to all adapters. If overridden, this property is not used.
duration Specify how long items in this cache configuration last.groups List of groups or 'tags' associated to every key stored in this config. handy for deleting a complete group from cache.prefix Prefix appended to all entries. Good for when you need to share a keyspace with either another cache config or another application.probability Probability of hitting a cache gc cleanup. Setting to 0 will disable cache::gc from ever being called automatically.[
'duration' => 3600,
'groups' => [],
'prefix' => 'cake_',
'probability' => 100
] protected string
Contains the compiled string with all groups prefixes to be prepended to every key in this cache engine
null
© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.4/class-Cake.Cache.CacheEngine.html