Class RedisEngine

Redis storage engine for cache.

Namespace: Cake\Cache\Engine

Property Summary

$_Redis protected

Redis

Redis wrapper.
$_config protected

array

Runtime config
$_configInitialized protected

bool

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

array

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

string

Contains the compiled string with all groups 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
_key() protected

Generates a safe key, taking account of the configured key prefix
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
clearGroup() public

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

Gets/Sets the config.
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
deleteMany() public

Deletes keys from the cache
gc() public

Garbage collection
getConfig() public

Returns the config.
getConfigOrFail() public

Returns the config for this specific key.
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.
increment() public

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

Initialize the Cache Engine
key() public

Generates a safe key for use with cache engine storage engines.
read() public

Read a key from the cache
readMany() public

Read multiple keys from the cache
setConfig() public

Sets the config.
warning() protected

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

Write data for key into cache.
writeMany() public

Write data for many keys into cache

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\Exception
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(string|array $key, mixed $value, bool|string $merge = false): void

Writes a config key.

Parameters

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.

Returns

void

Throws

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

_connect() ¶ protected

_connect(): bool

Connects to a Redis server

Returns

bool

_key() ¶ protected

_key(string $key): string

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

Parameters

string $key: the key passed over

Returns

string

Throws

InvalidArgumentException
If key's value is empty

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

Links

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

clear() ¶ public

clear(bool $check): bool

Delete all keys from the cache

Parameters

bool $check: If true will check expiration, otherwise delete all.

Returns

bool

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.

Parameters

string $group: name of the group to be cleared

Returns

bool

config() ¶ public

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

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

Parameters

string|array|null $key optional: The key to get/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

mixed

Throws

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

configShallow() ¶ public

configShallow(string|array $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

string|array $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

delete() ¶ public

delete(string $key): bool

Delete a key from the cache

Parameters

string $key: Identifier for the data

Returns

bool

deleteMany() ¶ public

deleteMany(array $keys): array

Deletes keys from the cache

Parameters

array $keys: An array of identifiers for the data

Returns

array

gc() ¶ public

gc(int|null $expires = null): void

Garbage collection

Permanently remove all expired and deleted data

Parameters

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

Returns

void

getConfig() ¶ public

getConfig(string|null $key = null, mixed|null $default = null): mixed|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: The key to get or null for the whole config.
mixed|null $default optional: The return value when the key does not exist.

Returns

mixed|null

getConfigOrFail() ¶ public

getConfigOrFail(string|null $key): mixed

Returns the config for this specific key.

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

Parameters

string|null $key: The key to get.

Returns

mixed

Throws

InvalidArgumentException

groups() ¶ public

groups(): 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

string[]

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

init() ¶ public

init(array $config = []): bool

Initialize the Cache Engine

Called automatically by the cache frontend

Parameters

array $config optional: array of setting for the engine

Returns

bool

key() ¶ public

key(string $key): string|false

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

Parameters

string $key: the key passed over

Returns

string|false

read() ¶ public

read(string $key): mixed

Read a key from the cache

Parameters

string $key: Identifier for the data

Returns

mixed

readMany() ¶ public

readMany(array $keys): array

Read multiple keys from the cache

Parameters

array $keys: An array of identifiers for the data

Returns

array

setConfig() ¶ public

setConfig(string|array $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

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.

Returns

$this

Throws

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

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

write() ¶ public

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

Write data for key into cache.

Parameters

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

Returns

bool

writeMany() ¶ public

writeMany(array $data): array

Write data for many keys into cache

Parameters

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

Returns

array

Property Detail

`$_Redis` ¶ protected

Redis wrapper.

Type

Redis

`$_config` ¶ protected

Runtime config

Type

array

`$_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.
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.
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

`$_groupPrefix` ¶ protected

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

Type

string

Namespaces

Class RedisEngine

Property Summary

Method Summary

__destruct() public

_configDelete() protected

_configRead() protected

_configWrite() protected

_connect() protected

_key() protected

add() public

clear() public

clearGroup() public

config() public deprecated

configShallow() public

decrement() public

delete() public

deleteMany() public

gc() public

getConfig() public

getConfigOrFail() public

groups() public

increment() public

init() public

key() public

read() public

readMany() public

setConfig() public

warning() protected

write() public

writeMany() public

Method Detail

__destruct() ¶ public

_configDelete() ¶ protected

Parameters

Returns

Throws

_configRead() ¶ protected

Parameters

Returns

_configWrite() ¶ protected

Parameters

Returns

Throws

_connect() ¶ protected

Returns

_key() ¶ protected

Parameters

Returns

Throws

add() ¶ public

Parameters

Returns

Links

clear() ¶ public

Parameters

Returns

clearGroup() ¶ public

Parameters

Returns

config() ¶ public

Usage

Parameters

Returns

Throws

configShallow() ¶ public

Parameters

Returns

decrement() ¶ public

Parameters

Returns

delete() ¶ public

Parameters

Returns

deleteMany() ¶ public

Parameters

Returns

gc() ¶ public

Parameters

Returns

`$_Redis` ¶ protected

`$_config` ¶ protected

`$_configInitialized` ¶ protected

`$_defaultConfig` ¶ protected

`$_groupPrefix` ¶ protected