Class RedisEngine

Redis storage engine for cache.

Namespace: Cake\Cache\Engine

Constants

string

CHECK_KEY ¶
```
'key'
```
string

CHECK_VALUE ¶
```
'value'
```

Property Summary

$_Redis protected

Redis

Redis wrapper.
$_config protected

array<string, mixed>

Runtime config
$_configInitialized protected

bool

Whether the config property has already been configured with defaults
$_defaultConfig protected

array<string, mixed>

The default config used unless overridden by runtime configuration
$_groupPrefix protected

string

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

Method Summary

__destruct() public

Disconnects from the redis server
_configDelete() protected

Deletes a single config key.
_configRead() protected

Reads a config key.
_configWrite() protected

Writes a config key.
_connect() protected

Connects to a Redis server
_connectPersistent() protected

Connects to a Redis server using a persistent connection.
_connectTransient() protected

Connects to a Redis server using a new connection.
_createRedisInstance() protected

Create new Redis instance.
_key() protected

Generates a key for cache backend usage.
add() public

Write data for key into cache if it doesn't exist already. If it already exists, it fails and returns false.
clear() public

Delete all keys from the cache
clearBlocking() public

Delete all keys from the cache by a blocking operation
clearGroup() public

Increments the group value to simulate deletion of all keys under a group old values will remain in storage until they expire.
configShallow() public

Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
decrement() public

Decrements the value of an integer cached key & update the expiry time
delete() public

Delete a key from the cache
deleteAsync() public

Delete a key from the cache asynchronously
deleteMultiple() public

Deletes multiple cache items as a list
duration() protected

Convert the various expressions of a TTL value into duration in seconds
ensureValidKey() protected

Ensure the validity of the given cache key.
ensureValidType() protected

Ensure the validity of the argument type and cache keys.
get() public

Read a key from the cache
getConfig() public

Returns the config.
getConfigOrFail() public

Returns the config for this specific key.
getMultiple() public

Obtains multiple cache items by their unique keys.
groups() public

Returns the group value for each of the configured groups If the group initial value was not found, then it initializes the group accordingly.
has() public

Determines whether an item is present in the cache.
increment() public

Increments the value of an integer cached key & update the expiry time
init() public

Initialize the Cache Engine
serialize() protected

Serialize value for saving to Redis.
set() public

Write data for key into cache.
setConfig() public

Sets the config.
setMultiple() public

Persists a set of key => value pairs in the cache, with an optional TTL.
unserialize() protected

Unserialize string value fetched from Redis.
warning() protected

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

Method Detail

__destruct() ¶ public

__destruct()

Disconnects from the redis server

_configDelete() ¶ protected

_configDelete(string $key): void

Deletes a single config key.

Parameters

string $key: Key to delete.

Returns

void

Throws

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

_configRead() ¶ protected

_configRead(string|null $key): mixed

Reads a config key.

Parameters

string|null $key: Key to read.

Returns

mixed

_configWrite() ¶ protected

_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

Writes a config key.

Parameters

array<string, mixed>|string $key: Key to write to.
mixed $value: Value to write.
string|bool $merge optional: True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

Returns

void

Throws

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

_connect() ¶ protected

_connect(): bool

Connects to a Redis server

Returns

bool

True if Redis server was connected

_connectPersistent() ¶ protected

_connectPersistent(string $server, array $ssl): bool

Connects to a Redis server using a persistent connection.

Parameters

string $server: Server to connect to.
array $ssl: SSL context options.

Returns

bool

True if Redis server was connected

Throws

RedisException

_connectTransient() ¶ protected

_connectTransient(string $server, array $ssl): bool

Connects to a Redis server using a new connection.

Parameters

string $server: Server to connect to.
array $ssl: SSL context options.

Returns

bool

True if Redis server was connected

Throws

RedisException

_createRedisInstance() ¶ protected

_createRedisInstance(): Redis

Create new Redis instance.

Returns

Redis

_key() ¶ protected

_key(string $key): string

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.

Parameters

string $key: the key passed over

Returns

string

Prefixed key with potentially unsafe characters replaced.

Throws

Cake\Cache\Exception\InvalidArgumentException
If key's value is invalid.

add() ¶ public

add(string $key, mixed $value): bool

Write data for key into cache if it doesn't exist already. If it already exists, it fails and returns false.

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

bool

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

Links

https://github.com/phpredis/phpredis#set

clear() ¶ public

clear(): bool

Delete all keys from the cache

Returns

bool

True if the cache was successfully cleared, false otherwise

clearBlocking() ¶ public

clearBlocking(): bool

Delete all keys from the cache by a blocking operation

Faster than clear() using unlink method.

Returns

bool

True if the cache was successfully cleared, false otherwise

clearGroup() ¶ public

clearGroup(string $group): bool

Increments the group value to simulate deletion of all keys under a group old values will remain in storage until they expire.

Each implementation needs to decide whether actually delete the keys or just augment a group generation value to achieve the same result.

Parameters

string $group: name of the group to be cleared

Returns

bool

success

configShallow() ¶ public

configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this

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

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

Returns

$this

decrement() ¶ public

decrement(string $key, int $offset = 1): int|false

Decrements the value of an integer cached key & update the expiry time

Parameters

string $key: Identifier for the data
int $offset optional: How much to subtract

Returns

int|false

New decremented value, false otherwise

delete() ¶ public

delete(string $key): bool

Delete a key from the cache

Parameters

string $key: Identifier for the data

Returns

bool

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

deleteAsync() ¶ public

deleteAsync(string $key): bool

Delete a key from the cache asynchronously

Just unlink a key from the cache. The actual removal will happen later asynchronously.

Parameters

string $key: Identifier for the data

Returns

bool

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

deleteMultiple() ¶ public

deleteMultiple(iterable $keys): bool

Deletes multiple cache items as a list

This is a best effort attempt. If deleting an item would create an error it will be ignored, and all items will be attempted.

Parameters

iterable $keys: A list of string-based keys to be deleted.

Returns

bool

True if the items were successfully removed. False if there was an error.

Throws

Cake\Cache\Exception\InvalidArgumentException
If $keys is neither an array nor a Traversable, or if any of the $keys are not a legal value.

duration() ¶ protected

duration(DateInterval|int|null $ttl): int

Convert the various expressions of a TTL value into duration in seconds

Parameters

DateInterval|int|null $ttl: The TTL value of this item. If null is sent, the driver's default duration will be used.

Returns

int

ensureValidKey() ¶ protected

ensureValidKey(string $key): void

Ensure the validity of the given cache key.

Parameters

string $key: Key to check.

Returns

void

Throws

Cake\Cache\Exception\InvalidArgumentException
When the key is not valid.

ensureValidType() ¶ protected

ensureValidType(iterable $iterable, string $check = self::CHECK_VALUE): void

Ensure the validity of the argument type and cache keys.

Parameters

iterable $iterable: The iterable to check.
string $check optional: Whether to check keys or values.

Returns

void

Throws

Cake\Cache\Exception\InvalidArgumentException

get() ¶ public

get(string $key, mixed $default = null): mixed

Read a key from the cache

Parameters

string $key: Identifier for the data
mixed $default optional: Default value to return if the key does not exist.

Returns

mixed

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

getConfig() ¶ public

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

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: The key to get or null for the whole config.
mixed $default optional: 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.

getConfigOrFail() ¶ public

getConfigOrFail(string $key): mixed

Returns the config for this specific key.

The config value for this key must exist, it can never be null.

Parameters

string $key: The key to get.

Returns

mixed

Configuration data at the named key

Throws

InvalidArgumentException

getMultiple() ¶ public

getMultiple(iterable $keys, mixed $default = null): iterable

Obtains multiple cache items by their unique keys.

Parameters

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.

Returns

iterable

A list of key value pairs. Cache keys that do not exist or are stale will have $default as value.

Throws

Cake\Cache\Exception\InvalidArgumentException
If $keys is neither an array nor a Traversable, or if any of the $keys are not a legal value.

groups() ¶ public

groups(): array<string>

Returns the group value for each of the configured groups If the group initial value was not found, then it initializes the group accordingly.

Returns

array<string>

has() ¶ public

has(string $key): bool

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.

Parameters

string $key: The cache item key.

Returns

bool

Throws

Cake\Cache\Exception\InvalidArgumentException
If the $key string is not a legal value.

increment() ¶ public

increment(string $key, int $offset = 1): int|false

Increments the value of an integer cached key & update the expiry time

Parameters

string $key: Identifier for the data
int $offset optional: How much to increment

Returns

int|false

New incremented value, false otherwise

init() ¶ public

init(array<string, mixed> $config = []): bool

Initialize the Cache Engine

Called automatically by the cache frontend

Parameters

array<string, mixed> $config optional: array of setting for the engine

Returns

bool

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

serialize() ¶ protected

serialize(mixed $value): string

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.

Parameters

mixed $value: Value to serialize.

Returns

string

Links

https://github.com/phpredis/phpredis/issues/81

set() ¶ public

set(string $key, mixed $value, DateInterval|int|null $ttl = null): bool

Write data for key into cache.

Parameters

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.

Returns

bool

True if the data was successfully cached, false on failure

setConfig() ¶ public

setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this

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

array<string, mixed>|string $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.

Returns

$this

Throws

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

setMultiple() ¶ public

setMultiple(iterable $values, DateInterval|int|null $ttl = null): bool

Persists a set of key => value pairs in the cache, with an optional TTL.

Parameters

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.

Returns

bool

True on success and false on failure.

Throws

Cake\Cache\Exception\InvalidArgumentException
If $values is neither an array nor a Traversable, or if any of the $values are not a legal value.

unserialize() ¶ protected

unserialize(string $value): mixed

Unserialize string value fetched from Redis.

Parameters

string $value: Value to unserialize.

Returns

mixed

warning() ¶ protected

warning(string $message): void

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

Parameters

string $message: The warning message.

Returns

void

Property Detail

`$_Redis` ¶ protected

Redis wrapper.

Type

Redis

`$_config` ¶ protected

Runtime config

Type

array<string, mixed>

`$_configInitialized` ¶ protected

Whether the config property has already been configured with defaults

Type

bool

`$_defaultConfig` ¶ protected

The 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 connection
port port number to the Redis server.
tls connect to the Redis server using TLS.
prefix Prefix appended to all entries. Good for when you need to share a keyspace with either another cache config or another application.
scanCount Number of keys to ask for each scan (default: 10)
server URL or IP to the Redis server host.
timeout timeout in seconds (float).
unix_socket Path to the unix socket file (default: false)

Type

array<string, mixed>

`$_groupPrefix` ¶ protected

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

Type

string

Namespaces

Class RedisEngine

Constants

Property Summary

Method Summary

__destruct() public

_configDelete() protected

_configRead() protected

_configWrite() protected

_connect() protected

_connectPersistent() protected

_connectTransient() protected

_createRedisInstance() protected

_key() protected

add() public

clear() public

clearBlocking() public

clearGroup() public

configShallow() public

decrement() public

delete() public

deleteAsync() public

deleteMultiple() public

duration() protected

ensureValidKey() protected

ensureValidType() protected

get() public

getConfig() public

getConfigOrFail() public

getMultiple() public

groups() public

has() public

increment() public

init() public

serialize() protected

set() public

setConfig() public

setMultiple() public

unserialize() protected

warning() protected

Method Detail

__destruct() ¶ public

_configDelete() ¶ protected

Parameters

Returns

Throws

_configRead() ¶ protected

Parameters

Returns

_configWrite() ¶ protected

Parameters

Returns

Throws

_connect() ¶ protected

Returns

_connectPersistent() ¶ protected

Parameters

Returns

Throws

_connectTransient() ¶ protected

Parameters

Returns

Throws

_createRedisInstance() ¶ protected

Returns

_key() ¶ protected

Parameters

Returns

Throws

add() ¶ public

Parameters

Returns

Links

clear() ¶ public

Returns

clearBlocking() ¶ public

Returns

clearGroup() ¶ public

Parameters

Returns