\Cake\Cache\EngineRedisEngine

Redis storage engine for cache.

Summary

Methods

Properties

Constants

init()
gc()
write()
writeMany()
read()
readMany()
increment()
decrement()
delete()
clear()
deleteMany()
add()
clearGroup()
groups()
key()
setConfig()
getConfig()
config()
configShallow()
__destruct()

No public properties found

No constants found

_key()
warning()
_configRead()
_configWrite()
_configDelete()
_connect()

$_defaultConfig
$_groupPrefix
$_config
$_configInitialized
$_Redis

N/A

No private methods found

No private properties found

N/A

File: vendor/cakephp/cakephp/src/Cache/Engine/RedisEngine.php
Package: Default
Class hierarchy: \Cake\Cache\CacheEngine

\Cake\Cache\Engine\RedisEngine

Properties

$_defaultConfig

$_defaultConfig : array

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

$_groupPrefix : string

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

Type

string

$_config

$_config : array

Runtime config

Type

array

$_configInitialized

$_configInitialized : boolean

Whether the config property has already been configured with defaults

Type

boolean

$_Redis

$_Redis : \Redis

Redis wrapper.

Type

\Redis

Methods

init()

init(array  $config = array()) : boolean

Initialize the Cache Engine

Called automatically by the cache frontend

Parameters

array

$config

array of setting for the engine

Returns

boolean —

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

gc()

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

Garbage collection

Permanently remove all expired and deleted data

Parameters

integer|null

$expires

[optional] An expires timestamp, invalidating all data before.

write()

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

Write data for 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()

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 —

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

read()

read(string  $key) : mixed

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

readMany(array  $keys) : array

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

increment()

increment(string  $key, integer  $offset = 1) : boolean|integer

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

Parameters

string	$key	Identifier for the data
integer	$offset	How much to increment

Returns

boolean|integer —

New incremented value, false otherwise

decrement()

decrement(string  $key, integer  $offset = 1) : boolean|integer

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

Parameters

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

Returns

boolean|integer —

New decremented value, false otherwise

delete()

delete(string  $key) : boolean

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

clear()

clear(boolean  $check) : boolean

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

deleteMany()

deleteMany(array  $keys) : array

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

add()

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

Write data for key into cache if it doesn't exist already.

If it already exists, it fails and returns false.

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.

clearGroup()

clearGroup(string  $group) : boolean

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

boolean —

success

groups()

groups() : array

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

key()

key(string  $key) : boolean|string

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

setConfig()

setConfig(string|array  $key, mixed|null  $value = null, boolean  $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	The value to set.
boolean	$merge	Whether to recursively merge or overwrite existing config, defaults to true.

Throws

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

Returns

$this

getConfig()

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	The key to get or null for the whole config.
mixed	$default	The return value when the key does not exist.

Returns

mixed —

Config value being read.

config()

config(string|array|null  $key = null, mixed|null  $value = null, boolean  $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	The key to get/set, or a complete array of configs.
mixed\|null	$value	The value to set.
boolean	$merge	Whether to recursively merge or overwrite existing config, defaults to true.

Throws

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

Returns

mixed —

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

configShallow()

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	The value to set.

Returns

$this

__destruct()

__destruct()

Disconnects from the redis server

_key()

_key(string  $key) : mixed

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

Parameters

string

$key

the key passed over

Throws

\InvalidArgumentException: If key's value is empty

Returns

mixed —

string $key or false

warning()

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.

_configRead()

_configRead(string|null  $key) : mixed

Reads a config key.

Parameters

string|null

$key

Key to read.

Returns

mixed

_configWrite()

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

Writes a config key.

Parameters

string\|array	$key	Key to write to.
mixed	$value	Value to write.
boolean\|string	$merge	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

_configDelete()

_configDelete(string  $key) : void

Deletes a single config key.

Parameters

string

$key

Key to delete.

Throws

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

_connect()

_connect() : boolean

Connects to a Redis server

Returns

boolean —

True if Redis server was connected