W3cubDocs

/CakePHP 3.8

Class CacheEngine

Storage engine for CakePHP caching

Cake\Cache\CacheEngine uses Cake\Core\InstanceConfigTrait

Direct Subclasses

Abstract
Namespace: Cake\Cache
Location: Cache/CacheEngine.php

Properties summary

  • $_defaultConfig 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.

  • $_groupPrefix protected
    string

    Contains the compiled string with all groups prefixes to be prepended to every key in this cache engine

Inherited Properties

Method Summary

  • _key() protected
    Generates a safe key, taking account of the configured key prefix
  • add() public
    Add a key to the cache if it does not already exist.
  • clear() abstract public
    Delete all keys from the cache
  • clearGroup() public

    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.

  • decrement() abstract public
    Decrement a number under the key and return decremented value
  • delete() abstract public
    Delete a key from the cache
  • deleteMany() public
    Deletes keys from the cache
  • gc() public
    Garbage collection
  • groups() public

    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() abstract public
    Increment a number under the key and return incremented value
  • init() public
    Initialize the cache engine
  • key() public
    Generates a safe key for use with cache engine storage engines.
  • read() abstract public
    Read a key from the cache
  • readMany() public
    Read multiple keys from the cache
  • warning() protected

    Cache Engines may trigger warnings if they encounter failures during operation, if option warnOnWriteFailures is set to true.

  • write() abstract public
    Write value for a key into cache
  • writeMany() public
    Write data for many keys into cache

Method Detail

_key()source protected

_key( string $key )

Generates a safe key, taking account of the configured key prefix

Parameters

string $key
the key passed over

Returns

mixed
string $key or false

Throws

InvalidArgumentException
If key's value is empty

add()source public

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.

Parameters

string $key
Identifier for the data.
mixed $value
Data to be cached.

Returns

boolean
True if the data was successfully cached, false on failure.

clear()source abstract public

clear( boolean $check )

Delete all keys from the cache

Parameters

boolean $check
if true will check expiration, otherwise delete all

Returns

boolean
True if the cache was successfully cleared, false otherwise

clearGroup()source public

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.

Parameters

string $group
name of the group to be cleared

Returns

boolean

decrement()source abstract public

decrement( string $key , integer $offset = 1 )

Decrement a number under the key and return decremented value

Parameters

string $key
Identifier for the data
integer $offset optional 1
How much to subtract

Returns

boolean|integer
New incremented value, false otherwise

delete()source abstract public

delete( string $key )

Delete a key from the cache

Parameters

string $key
Identifier for the data

Returns

boolean
True if the value was successfully deleted, false if it didn't exist or couldn't be removed

deleteMany()source public

deleteMany( array $keys )

Deletes keys from the cache

Parameters

array $keys
An array of identifiers for the data

Returns

array

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()source public

gc( integer|null $expires = null )

Garbage collection

Permanently remove all expired and deleted data

Parameters

integer|null $expires optional null
[optional] An expires timestamp, invalidating all data before.

groups()source public

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

Returns

array

increment()source abstract public

increment( string $key , integer $offset = 1 )

Increment a number under the key and return incremented value

Parameters

string $key
Identifier for the data
integer $offset optional 1
How much to add

Returns

boolean|integer
New incremented value, false otherwise

init()source public

init( array $config = [] )

Initialize the cache engine

Called automatically by the cache frontend. Merge the runtime config with the defaults before use.

Parameters

array $config optional []
Associative array of parameters for the engine

Returns

boolean
True if the engine has been successfully initialized, false if not

key()source public

key( string $key )

Generates a safe key for use with cache engine storage engines.

Parameters

string $key
the key passed over

Returns

boolean|string
string key or false

read()source abstract public

read( string $key )

Read a key from the cache

Parameters

string $key
Identifier for the data

Returns

mixed
The cached data, or false if the data doesn't exist, has expired, or if there was an error fetching it

readMany()source public

readMany( array $keys )

Read multiple keys from the cache

Parameters

array $keys
An array of identifiers for the data

Returns

array

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


warning()source protected

warning( string $message )

Cache Engines may trigger warnings if they encounter failures during operation, if option warnOnWriteFailures is set to true.

Parameters

string $message
The warning message.

write()source abstract public

write( string $key , mixed $value )

Write value for a key into cache

Parameters

string $key
Identifier for the data
mixed $value
Data to be cached

Returns

boolean
True if the data was successfully cached, false on failure

writeMany()source public

writeMany( array $data )

Write data for many keys into cache

Parameters

array $data
An array of data to be stored in the cache

Returns

array
of bools for each key provided, true if the data was successfully cached, false on failure

Methods used from Cake\Core\InstanceConfigTrait

_configDelete()source protected

_configDelete( string $key )

Deletes a single config key.

Parameters

string $key
Key to delete.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_configRead()source protected

_configRead( string|null $key )

Reads a config key.

Parameters

string|null $key
Key to read.

Returns

mixed

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge = false )

Writes a config key.

Parameters

string|array $key
Key to write to.
mixed $value
Value to write.
boolean|string $merge optional false

True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

config()source public deprecated

config( string|array|null $key = null , mixed|null $value = null , boolean $merge = true )

Gets/Sets the config.

Usage

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']);

Deprecated

3.4.0 use setConfig()/getConfig() instead.

Parameters

string|array|null $key optional null
The key to get/set, or a complete array of configs.
mixed|null $value optional null
The value to set.
boolean $merge optional true
Whether to recursively merge or overwrite existing config, defaults to true.

Returns

mixed
Config value being read, or the object itself on write operations.

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

configShallow()source public

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->configShallow('key', $value);

Setting a nested value:

$this->configShallow('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Parameters

string|array $key
The key to set, or a complete array of configs.
mixed|null $value optional null
The value to set.

Returns


$this

getConfig()source public

getConfig( string|null $key = null , mixed $default = null )

Returns the config.

Usage

Reading the whole config:

$this->getConfig();

Reading a specific value:

$this->getConfig('key');

Reading a nested value:

$this->getConfig('some.nested.key');

Reading with default value:

$this->getConfig('some-key', 'default-value');

Parameters

string|null $key optional null
The key to get or null for the whole config.
mixed $default optional null
The return value when the key does not exist.

Returns

mixed
Configuration data at the named key or null if the key does not exist.

setConfig()source public

setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )

Sets the config.

Usage

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']);

Parameters

string|array $key
The key to set, or a complete array of configs.
mixed|null $value optional null
The value to set.
boolean $merge optional true
Whether to recursively merge or overwrite existing config, defaults to true.

Returns


$this

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

Properties detail

$_defaultConfigsource

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.
  • warnOnWriteFailures Some engines, such as ApcuEngine, may raise warnings on write failures.
[
    'duration' => 3600,
    'groups' => [],
    'prefix' => 'cake_',
    'probability' => 100,
    'warnOnWriteFailures' => true,
]

$_groupPrefixsource

protected string

Contains the compiled string with all groups prefixes to be prepended to every key in this cache engine

© 2005–present 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.8/class-Cake.Cache.CacheEngine.html