Redis storage engine for cache.
string 'key' string 'value' \RedisRedis wrapper.
arrayRuntime config
boolWhether the config property has already been configured with defaults
arrayThe default config used unless overridden by runtime configuration
stringContains the compiled string with all group prefixes to be prepended to every key in this cache engine
Increments the group value to simulate deletion of all keys under a group old values will remain in storage until they expire.
Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
Returns the group value for each of the configured groups If the group initial value was not found, then it initializes the group accordingly.
Cache Engines may trigger warnings if they encounter failures during operation, if option warnOnWriteFailures is set to true.
__destruct()
Disconnects from the redis server
_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_connect()
Connects to a Redis server
boolTrue if Redis server was connected
_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)
Write data for key into cache if it doesn't exist already.
If it already exists, it fails and returns false.
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)
Increments the group value to simulate deletion of all keys under a group old values will remain in storage until they expire.
string $group name of the group to be cleared
boolsuccess
configShallow(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)
Decrements the value of an integer cached key & update the expiry time
string $key Identifier for the data
int $offset optional How much to subtract
int|falseNew decremented 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)
Read a key from the cache
string $key Identifier for the data
mixed $default optional Default value to return if the key does not exist.
mixedThe cached data, or the default if the data doesn't exist, has expired, or if there was an error fetching it
getConfig(?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()
Returns the group value for each of the configured groups If the group initial value was not found, then it initializes the group accordingly.
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)
Increments the value of an integer cached key & update the expiry time
string $key Identifier for the data
int $offset optional How much to increment
int|falseNew incremented value, false otherwise
init(array $config)
Initialize the Cache Engine
Called automatically by the cache frontend
array $config optional array of setting for the engine
boolTrue if the engine has been successfully initialized, false if not
serialize(mixed $value)
Serialize value for saving to Redis.
This is needed instead of using Redis' in built serialization feature as it creates problems incrementing/decrementing intially set integer value.
mixed $value Value to serialize.
stringset(mixed $key, mixed $value, mixed $ttl)
Write data for key into cache.
string $key Identifier for the data
mixed $value Data to be cached
\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 if the data was successfully cached, false on failure
setConfig(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\InvalidArgumentExceptionunserialize(string $value)
Unserialize string value fetched from Redis.
string $value Value to unserialize.
mixedwarning(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.
Redis wrapper.
\RedisRuntime config
arrayWhether the config property has already been configured with defaults
boolThe default config used unless overridden by runtime configuration
database database number to use for connection.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.password Redis server password.persistent Connect to the Redis server with a persistent connectionport port number to the Redis server.prefix Prefix appended to all entries. Good for when you need to share a keyspace with either another cache config or another application.server URL or IP to the Redis server host.timeout timeout in seconds (float).unix_socket Path to the unix socket file (default: false)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.Engine.RedisEngine.html