Class RedisEngine
Redis storage engine for cache.
Property Summary
-
$_Redis protected
RedisRedis wrapper.
-
$_config protected
arrayRuntime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
arrayThe default config used unless overridden by runtime configuration
-
$_groupPrefix protected
stringContains 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
Delete a single config key
-
_configRead() protected
Read a config variable
-
_configWrite() protected
Write a config variable
-
_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
Usage
-
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
-
delete() public
Delete a key from the cache
-
deleteMany() public
Deletes keys from the cache
-
gc() public
Garbage collection
-
groups() public
Returns the
group valuefor 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
-
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
-
write() public
Write data for key into cache.
-
writeMany() public
Write data for many keys into cache
Method Detail
_configDelete() ¶ protected
_configDelete(string $key): voidDelete a single config key
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixedRead a config variable
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() ¶ protected
_configWrite(string|array $key, mixed $value, bool|string $merge = false): voidWrite a config variable
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
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_connect() ¶ protected
_connect(): boolConnects to a Redis server
Returns
boolTrue if Redis server was connected
_key() ¶ protected
_key(string $key): mixedGenerates a safe key, taking account of the configured key prefix
Parameters
-
string$key the key passed over
Returns
mixedstring $key or false
Throws
InvalidArgumentExceptionIf key's value is empty
add() ¶ public
add(string $key, mixed $value): boolWrite 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
boolTrue if the data was successfully cached, false on failure.
Links
clear() ¶ public
clear(bool $check): boolDelete all keys from the cache
Parameters
-
bool$check If true will check expiration, otherwise delete all.
Returns
boolTrue if the cache was successfully cleared, false otherwise
clearGroup() ¶ public
clearGroup(string $group): boolIncrements 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
boolsuccess
config() ¶ public
config(string|array|null $key = null, mixed|null $value = null, bool $merge = true): mixedUsage
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
mixedConfig value being read, or the object itself on write operations.
Throws
Cake\Core\Exception\ExceptionWhen trying to set a key that is invalid.
configShallow() ¶ public
configShallow(string|array $key, mixed|null $value = null): $thisMerge 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->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$key The key to set, or a complete array of configs.
-
mixed|null$value optional The value to set.
Returns
$thisThe object itself.
decrement() ¶ public
decrement(string $key, int $offset = 1): bool|intDecrements the value of an integer cached key
Parameters
-
string$key Identifier for the data
-
int$offset optional How much to subtract
Returns
bool|intNew decremented value, false otherwise
delete() ¶ public
delete(string $key): boolDelete a key from the cache
Parameters
-
string$key Identifier for the data
Returns
boolTrue if the value was successfully deleted, false if it didn't exist or couldn't be removed
deleteMany() ¶ public
deleteMany(array $keys): arrayDeletes keys from the cache
Parameters
-
array$keys An array of identifiers for the data
Returns
arrayFor 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
gc() ¶ public
gc(int|null $expires = null): voidGarbage collection
Permanently remove all expired and deleted data
Parameters
-
int|null$expires optional [optional] An expires timestamp, invalidating all data before.
Returns
voidgroups() ¶ public
groups(): arrayReturns the group value for each of the configured groups
If the group initial value was not found, then it initializes
the group accordingly.
Returns
arrayincrement() ¶ public
increment(string $key, int $offset = 1): bool|intIncrements the value of an integer cached key
Parameters
-
string$key Identifier for the data
-
int$offset optional How much to increment
Returns
bool|intNew incremented value, false otherwise
init() ¶ public
init(array $config = []): boolInitialize the Cache Engine
Called automatically by the cache frontend
Parameters
-
array$config optional array of setting for the engine
Returns
boolTrue if the engine has been successfully initialized, false if not
key() ¶ public
key(string $key): bool|stringGenerates a safe key for use with cache engine storage engines.
Parameters
-
string$key the key passed over
Returns
bool|stringstring key or false
read() ¶ public
read(string $key): mixedRead a key from the cache
Parameters
-
string$key Identifier for the data
Returns
mixedThe cached data, or false if the data doesn't exist, has expired, or if there was an error fetching it
readMany() ¶ public
readMany(array $keys): arrayRead multiple keys from the cache
Parameters
-
array$keys An array of identifiers for the data
Returns
arrayFor 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
write() ¶ public
write(string $key, mixed $value): boolWrite data for key into cache.
Parameters
-
string$key Identifier for the data
-
mixed$value Data to be cached
Returns
boolTrue if the data was successfully cached, false on failure
writeMany() ¶ public
writeMany(array $data): arrayWrite data for many keys into cache
Parameters
-
array$data An array of data to be stored in the cache
Returns
arrayof bools for each key provided, true if the data was successfully cached, false on failure
Property Detail
$_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
databasedatabase number to use for connection.durationSpecify how long items in this cache configuration last.groupsList of groups or 'tags' associated to every key stored in this config. handy for deleting a complete group from cache.passwordRedis server password.persistentConnect to the Redis server with a persistent connectionportport number to the Redis server.prefixPrefix appended to all entries. Good for when you need to share a keyspace with either another cache config or another application.probabilityProbability of hitting a cache gc cleanup. Setting to 0 will disable cache::gc from ever being called automatically.serverURL or ip to the Redis server host.timeouttimeout in seconds (float).unix_socketPath 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