Null cache engine, all operations return false.
This is used internally for when Cache::disable() has been called.
clear( boolean $check )
Delete all keys from the cache
$check
boolean
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
boolean
Cake\Cache\CacheEngine::clearGroup()
decrement( string $key , integer $offset 1 )
Decrement a number under the key and return decremented value
$key
$offset
optional 1 boolean|integer
delete( string $key )
Delete a key from the cache
$key
boolean
deleteMany( array $keys )
Deletes keys from the cache
$keys
array
Cake\Cache\CacheEngine::deleteMany()
gc( integer|null $expires null )
Garbage collection
$expires
optional null Cake\Cache\CacheEngine::gc()
increment( string $key , integer $offset 1 )
Increment a number under the key and return incremented value
$key
$offset
optional 1 boolean|integer
init( array $config [] )
Initialize the cache engine
$config
optional [] boolean
Cake\Cache\CacheEngine::init()
read( string $key )
Read a key from the cache
$key
mixed
readMany( array $keys )
Read multiple keys from the cache
$keys
array
Cake\Cache\CacheEngine::readMany()
write( string $key , mixed $value )
Write value for a key into cache
$key
$value
boolean
writeMany( array $data )
Write data for many keys into cache
$data
array
Cake\Cache\CacheEngine::writeMany()
_key( string $key )
Generates a safe key, taking account of the configured key prefix
$key
mixed
InvalidArgumentException
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
boolean
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
array
key( string $key )
Generates a safe key for use with cache engine storage engines.
$key
boolean|string
_configDelete( string $key )
Delete a single config key
$key
Cake\Core\Exception\Exception
_configRead( string|null $key )
Read a config variable
$key
mixed
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Write a config variable
$key
$value
$merge
optional false Cake\Core\Exception\Exception
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
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 mixed
Cake\Core\Exception\Exception
configShallow( 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 mixed
protected 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
protected boolean
Whether the config property has already been configured with defaults
false
© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Cache.Engine.NullEngine.html