Storage engine for CakePHP caching
string 'key' string 'value' arrayRuntime config
boolWhether the config property has already been configured with defaults
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.
stringContains the compiled string with all group 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.
Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
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
Persists data in the cache, uniquely referenced by the given key with an optional expiration TTL time.
Cache Engines may trigger warnings if they encounter failures during operation, if option warnOnWriteFailures is set to true.
_configDelete(string $key)
Deletes a single config key.
string $key Key to delete.
Cake\Core\Exception\Exception_configRead(?string $key)
Reads a config key.
string|null $key Key to read.
mixed_configWrite(mixed $key, mixed $value, mixed $merge)
Writes a config key.
string|array $key Key to write to.
mixed $value Value to write.
bool|string $merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Cake\Core\Exception\Exception_key(mixed $key)
Generates a key for cache backend usage.
If the requested key is valid, the group prefix value and engine prefix are applied. Whitespace in keys will be replaced.
string $key the key passed over
stringPrefixed key with potentially unsafe characters replaced.
Cake\Cache\InvalidArgumentExceptionadd(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.
string $key Identifier for the data.
mixed $value Data to be cached.
boolTrue if the data was successfully cached, false on failure.
clear()
Delete all keys from the cache
boolTrue if the cache was successfully cleared, false otherwise
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.
string $group name of the group to be cleared
boolconfigShallow(mixed $key, mixed $value)
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']);
string|array $key The key to set, or a complete array of configs.
mixed|null $value optional The value to set.
$thisdecrement(string $key, int $offset)
Decrement a number under the key and return decremented value
string $key Identifier for the data
int $offset optional How much to subtract
int|falseNew incremented value, false otherwise
delete(mixed $key)
Delete a key from the cache
string $key Identifier for the data
boolTrue if the value was successfully deleted, false if it didn't exist or couldn't be removed
deleteMultiple(mixed $keys)
Deletes multiple cache items in a single operation.
iterable $keys A list of string-based keys to be deleted.
boolTrue if the items were successfully removed. False if there was an error.
Cake\Cache\InvalidArgumentExceptionduration(mixed $ttl)
Convert the various expressions of a TTL value into duration in seconds
\DateInterval|int|null $ttl The TTL value of this item. If null is sent, the driver's default duration will be used.
intensureValidKey(mixed $key)
Ensure the validity of the given cache key.
string $key Key to check.
Cake\Cache\InvalidArgumentExceptionensureValidType(mixed $iterable, string $check)
Ensure the validity of the argument type and cache keys.
iterable $iterable The iterable to check.
string $check optional Whether to check keys or values.
Cake\Cache\InvalidArgumentExceptionget(mixed $key, mixed $default)
Fetches the value for a given key from the cache.
string $key The unique key of this item in the cache.
mixed $default optional Default value to return if the key does not exist.
mixedThe value of the item from the cache, or $default in case of cache miss.
Cake\Cache\InvalidArgumentExceptiongetConfig(?string $key, mixed $default)
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'); Reading with default value:
$this->getConfig('some-key', 'default-value'); string|null $key optional The key to get or null for the whole config.
mixed $default optional The return value when the key does not exist.
mixedConfiguration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string $key The key to get.
mixedConfiguration data at the named key
InvalidArgumentExceptiongetMultiple(mixed $keys, mixed $default)
Obtains multiple cache items by their unique keys.
iterable $keys A list of keys that can obtained in a single operation.
mixed $default optional Default value to return for keys that do not exist.
iterableA list of key value pairs. Cache keys that do not exist or are stale will have $default as value.
Cake\Cache\InvalidArgumentExceptiongroups()
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
string[]has(mixed $key)
Determines whether an item is present in the cache.
NOTE: It is recommended that has() is only to be used for cache warming type purposes and not to be used within your live applications operations for get/set, as this method is subject to a race condition where your has() will return true and immediately after, another script can remove it making the state of your app out of date.
string $key The cache item key.
boolCake\Cache\InvalidArgumentExceptionincrement(string $key, int $offset)
Increment a number under the key and return incremented value
string $key Identifier for the data
int $offset optional How much to add
int|falseNew incremented value, false otherwise
init(array $config)
Initialize the cache engine
Called automatically by the cache frontend. Merge the runtime config with the defaults before use.
array $config optional Associative array of parameters for the engine
boolTrue if the engine has been successfully initialized, false if not
set(mixed $key, mixed $value, mixed $ttl)
Persists data in the cache, uniquely referenced by the given key with an optional expiration TTL time.
string $key The key of the item to store.
mixed $value The value of the item to store, must be serializable.
\DateInterval|int|null $ttl optional Optional. The TTL value of this item. If no value is sent and the driver supports TTL then the library may set a default value for it or let the driver take care of that.
boolTrue on success and false on failure.
Cake\Cache\InvalidArgumentExceptionsetConfig(mixed $key, mixed $value, mixed $merge)
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']);
string|array $key The key to set, or a complete array of configs.
mixed|null $value optional The value to set.
bool $merge optional Whether to recursively merge or overwrite existing config, defaults to true.
$thisCake\Core\Exception\ExceptionsetMultiple(mixed $values, mixed $ttl)
Persists a set of key => value pairs in the cache, with an optional TTL.
iterable $values A list of key => value pairs for a multiple-set operation.
\DateInterval|int|null $ttl optional Optional. The TTL value of this item. If no value is sent and the driver supports TTL then the library may set a default value for it or let the driver take care of that.
boolTrue on success and false on failure.
Cake\Cache\InvalidArgumentExceptionwarning(string $message)
Cache Engines may trigger warnings if they encounter failures during operation, if option warnOnWriteFailures is set to true.
string $message The warning message.
Runtime config
arrayWhether the config property has already been configured with defaults
boolThe 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.warnOnWriteFailures Some engines, such as ApcuEngine, may raise warnings on write failures.arrayContains the compiled string with all group prefixes to be prepended to every key in this cache engine
string
© 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/4.1/class-Cake.Cache.CacheEngine.html