APC storage engine for cache
add( string $key , mixed $value )
Write data for key into cache if it doesn't exist already. If it already exists, it fails and returns false.
$key
$value
boolean
Cake\Cache\CacheEngine::add()
clear( boolean $check )
Delete all keys from the cache. This will clear every cache config using APC.
$check
boolean
clearGroup( string $group )
Increments the group value to simulate deletion of all keys under a group old values will remain in storage until they expire.
$group
boolean
Cake\Cache\CacheEngine::clearGroup()
decrement( string $key , integer $offset 1 )
Decrements the value of an integer cached key
$key
$offset
optional 1 boolean|integer
delete( string $key )
Delete a key from the cache
$key
boolean
groups( )
Returns the group value
for each of the configured groups If the group initial value was not found, then it initializes the group accordingly.
array
Cake\Cache\CacheEngine::groups()
increment( string $key , integer $offset 1 )
Increments the value of an integer cached key
$key
$offset
optional 1 boolean|integer
init( array $config [] )
Initialize the Cache Engine
Called automatically by the cache frontend
$config
optional [] boolean
Cake\Cache\CacheEngine::init()
read( string $key )
Read a key from the cache
$key
mixed
write( string $key , mixed $value )
Write data for key into cache
$key
$value
boolean
_key( string $key )
Generates a safe key, taking account of the configured key prefix
$key
mixed
InvalidArgumentException
deleteMany( array $keys )
Deletes keys from the cache
$keys
array
gc( integer|null $expires null )
Garbage collection
Permanently remove all expired and deleted data
$expires
optional null key( string $key )
Generates a safe key for use with cache engine storage engines.
$key
boolean|string
readMany( array $keys )
Read multiple keys from the cache
$keys
array
writeMany( array $data )
Write data for many keys into cache
$data
array
_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.ApcEngine.html