Class RedisEngine
Redis storage engine for cache.
- Cake\Cache\CacheEngine uses Cake\Core\InstanceConfigTrait
-
Cake\Cache\Engine\RedisEngine
Properties summary
-
$_RedisprotectedRedisRedis wrapper. -
$_defaultConfigprotectedarrayThe default config used unless overridden by runtime configuration
Inherited Properties
Method Summary
-
__destruct() public
Disconnects from the redis server -
_connect() protected
Connects to a Redis server -
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.
-
decrement() public
Decrements the value of an integer cached key & update the expiry time -
delete() public
Delete a key from the cache -
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 & update the expiry time -
init() public
Initialize the Cache Engine -
read() public
Read a key from the cache -
write() public
Write data for key into cache.
Method Detail
_connect() protected ¶
_connect( )
Connects to a Redis server
Returns
True if Redis server was connected
add() public ¶
add( 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.
Parameters
- string $key
- Identifier for the data.
- mixed $value
- Data to be cached.
Returns
True if the data was successfully cached, false on failure.
Link
Overrides
clear() public ¶
clear( boolean $check )
Delete all keys from the cache
Parameters
- boolean $check
- If true will check expiration, otherwise delete all.
Returns
True if the cache was successfully cleared, false otherwise
clearGroup() public ¶
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.
Parameters
- string $group
- name of the group to be cleared
Returns
success
Overrides
decrement() public ¶
decrement( string $key , integer $offset 1 )
Decrements the value of an integer cached key & update the expiry time
Parameters
- string $key
- Identifier for the data
- integer $offset optional 1
- How much to subtract
Returns
New decremented value, false otherwise
delete() public ¶
delete( string $key )
Delete a key from the cache
Parameters
- string $key
- Identifier for the data
Returns
True if the value was successfully deleted, false if it didn't exist or couldn't be removed
groups() public ¶
groups( )
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
Overrides
increment() public ¶
increment( string $key , integer $offset 1 )
Increments the value of an integer cached key & update the expiry time
Parameters
- string $key
- Identifier for the data
- integer $offset optional 1
- How much to increment
Returns
New incremented value, false otherwise
init() public ¶
init( array $config [] )
Initialize the Cache Engine
Called automatically by the cache frontend
Parameters
- array $config optional []
- array of setting for the engine
Returns
True if the engine has been successfully initialized, false if not
Overrides
Methods inherited from Cake\Cache\CacheEngine
_key() protected ¶
_key( string $key )
Generates a safe key, taking account of the configured key prefix
Parameters
- string $key
- the key passed over
Returns
string $key or false
Throws
If key's value is empty
deleteMany() public ¶
deleteMany( array $keys )
Deletes keys from the cache
Parameters
- array $keys
- An array of identifiers for the data
Returns
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
gc() public ¶
gc( integer|null $expires null )
Garbage collection
Permanently remove all expired and deleted data
Parameters
- integer|null $expires optional null
- [optional] An expires timestamp, invalidating all data before.
key() public ¶
key( string $key )
Generates a safe key for use with cache engine storage engines.
Parameters
- string $key
- the key passed over
Returns
string key or false
readMany() public ¶
readMany( array $keys )
Read multiple keys from the cache
Parameters
- array $keys
- An array of identifiers for the data
Returns
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
warning() protected ¶
warning( string $message )
Cache Engines may trigger warnings if they encounter failures during operation, if option warnOnWriteFailures is set to true.
Parameters
- string $message
- The warning message.
writeMany() public ¶
writeMany( array $data )
Write data for many keys into cache
Parameters
- array $data
- An array of data to be stored in the cache
Returns
of bools for each key provided, true if the data was successfully cached, false on failure
Methods used from Cake\Core\InstanceConfigTrait
_configDelete() protected ¶
_configDelete( string $key )
Deletes a single config key.
Parameters
- string $key
- Key to delete.
Throws
_configRead() protected ¶
_configRead( string|null $key )
Reads a config key.
Parameters
- string|null $key
- Key to read.
Returns
_configWrite() protected ¶
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Writes a config key.
Parameters
- string|array $key
- Key to write to.
- mixed $value
- Value to write.
- boolean|string $merge optional false
True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Throws
config() public ¶
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
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']);
Deprecated
Parameters
- string|array|null $key optional null
- The key to get/set, or a complete array of configs.
- mixed|null $value optional null
- The value to set.
- boolean $merge optional true
- Whether to recursively merge or overwrite existing config, defaults to true.
Returns
Config value being read, or the object itself on write operations.
Throws
configShallow() public ¶
configShallow( string|array $key , mixed|null $value null )
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 null
- The value to set.
Returns
$this
getConfig() public ¶
getConfig( string|null $key null , mixed $default 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 null
- The key to get or null for the whole config.
- mixed $default optional null
- The return value when the key does not exist.
Returns
Config value being read.
setConfig() public ¶
setConfig( string|array $key , mixed|null $value null , boolean $merge true )
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 null
- The value to set.
- boolean $merge optional true
- Whether to recursively merge or overwrite existing config, defaults to true.
Returns
$this
Throws
Properties detail
$_defaultConfig ¶
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)
[
'database' => 0,
'duration' => 3600,
'groups' => [],
'password' => false,
'persistent' => true,
'port' => 6379,
'prefix' => 'cake_',
'probability' => 100,
'host' => null,
'server' => '127.0.0.1',
'timeout' => 0,
'unix_socket' => false,
]