Fr3nch13/CakePHP Utilities

RedisEngine extends CacheEngine
in package

Application

Redis storage engine for cache.

Constants

CHECK_KEY = 'key'
CHECK_VALUE = 'value'

Properties

$_config : array<string, mixed>: Runtime config
$_configInitialized : bool: Whether the config property has already been configured with defaults
$_defaultConfig : array<string, mixed>: The default config used unless overridden by runtime configuration
$_groupPrefix : string: Contains the compiled string with all group prefixes to be prepended to every key in this cache engine
$_Redis : Redis: Redis wrapper.

Methods

__destruct() : mixed: Disconnects from the redis server
add() : bool: Write data for key into cache if it doesn't exist already.
clear() : bool: Delete all keys from the cache
clearBlocking() : bool: Delete all keys from the cache by a blocking operation
clearGroup() : bool: Increments the group value to simulate deletion of all keys under a group old values will remain in storage until they expire.
configShallow() : $this: Merge provided config with existing config. Unlike `config()` which does a recursive merge for nested keys, this method does a simple merge.
decrement() : int|false: Decrements the value of an integer cached key & update the expiry time
delete() : bool: Delete a key from the cache
deleteAsync() : bool: Delete a key from the cache asynchronously
deleteMultiple() : bool: Deletes multiple cache items as a list
get() : mixed: Read a key from the cache
getConfig() : mixed: Returns the config.
getConfigOrFail() : mixed: Returns the config for this specific key.
getMultiple() : iterable<string|int, mixed>: Obtains multiple cache items by their unique keys.
groups() : array<string|int, 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.
has() : bool: Determines whether an item is present in the cache.
increment() : int|false: Increments the value of an integer cached key & update the expiry time
init() : bool: Initialize the Cache Engine
set() : bool: Write data for key into cache.
setConfig() : $this: Sets the config.
setMultiple() : bool: Persists a set of key => value pairs in the cache, with an optional TTL.
_configDelete() : void: Deletes a single config key.
_configRead() : mixed: Reads a config key.
_configWrite() : void: Writes a config key.
_connect() : bool: Connects to a Redis server
_key() : string: Generates a key for cache backend usage.
duration() : int: Convert the various expressions of a TTL value into duration in seconds
ensureValidKey() : void: Ensure the validity of the given cache key.
ensureValidType() : void: Ensure the validity of the argument type and cache keys.
serialize() : string: Serialize value for saving to Redis.
unserialize() : mixed: Unserialize string value fetched from Redis.
warning() : void: Cache Engines may trigger warnings if they encounter failures during operation, if option warnOnWriteFailures is set to true.

CHECK_KEY


    protected
        string
    CHECK_KEY
    = 'key'

CHECK_VALUE


    protected
        string
    CHECK_VALUE
    = 'value'

$_config

Runtime config


    protected
        array<string, mixed>
    $_config
     = []

$_configInitialized

Whether the config property has already been configured with defaults


    protected
        bool
    $_configInitialized
     = false

$_defaultConfig

The default config used unless overridden by runtime configuration


    protected
        array<string, mixed>
    $_defaultConfig
     = ['database' => 0, 'duration' => 3600, 'groups' => [], 'password' => false, 'persistent' => true, 'port' => 6379, 'prefix' => 'cake_', 'host' => null, 'server' => '127.0.0.1', 'timeout' => 0, 'unix_socket' => false, 'scanCount' => 10]

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

$_groupPrefix

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


    protected
        string
    $_groupPrefix
     = ''

$_Redis

Redis wrapper.


    protected
        Redis
    $_Redis

__destruct()

Disconnects from the redis server


    public
                    __destruct() : mixed

add()

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


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

If it already exists, it fails and returns false.

Parameters

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

Return values

bool —

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

clear()

Delete all keys from the cache


    public
                    clear() : bool

Return values

bool —

True if the cache was successfully cleared, false otherwise

clearBlocking()

Delete all keys from the cache by a blocking operation


    public
                    clearBlocking() : bool

Faster than clear() using unlink method.

Return values

bool —

True if the cache was successfully cleared, false otherwise

clearGroup()

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


    public
                    clearGroup(string $group) : bool

Parameters

$group : string: name of the group to be cleared

Return values

bool —

success

configShallow()

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


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

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

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

Return values

$this

decrement()

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


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

Parameters

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

Return values

int|false —

New decremented value, false otherwise

delete()

Delete a key from the cache


    public
                    delete(string $key) : bool

Parameters

$key : string: Identifier for the data

Return values

bool —

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

deleteAsync()

Delete a key from the cache asynchronously


    public
                    deleteAsync(string $key) : bool

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

Parameters

$key : string: Identifier for the data

Return values

bool —

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

deleteMultiple()

Deletes multiple cache items as a list


    public
                    deleteMultiple(iterable<string|int, mixed> $keys) : bool

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

$keys : iterable<string|int, mixed>: A list of string-based keys to be deleted.

Return values

bool —

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

get()

Read a key from the cache


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

Parameters

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

Return values

mixed —

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

getConfig()

Returns the config.


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

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

$key : string|null = null: The key to get or null for the whole config.
$default : mixed = null: The return value when the key does not exist.

Return values

mixed —

Configuration data at the named key or null if the key does not exist.

getConfigOrFail()

Returns the config for this specific key.


    public
                    getConfigOrFail(string $key) : mixed

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

Parameters

$key : string: The key to get.

Return values

mixed —

Configuration data at the named key

getMultiple()

Obtains multiple cache items by their unique keys.


    public
                    getMultiple(iterable<string|int, mixed> $keys[, mixed $default = null ]) : iterable<string|int, mixed>

Parameters

$keys : iterable<string|int, mixed>: A list of keys that can obtained in a single operation.
$default : mixed = null: Default value to return for keys that do not exist.

Return values

iterable<string|int, mixed> —

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

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.


    public
                    groups() : array<string|int, string>

Return values

array<string|int, string>

has()

Determines whether an item is present in the cache.


    public
                    has(string $key) : bool

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

$key : string: The cache item key.

Return values

bool

increment()

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


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

Parameters

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

Return values

int|false —

New incremented value, false otherwise

init()

Initialize the Cache Engine


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

Called automatically by the cache frontend

Parameters

$config : array<string, mixed> = []: array of setting for the engine

Return values

bool —

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

set()

Write data for key into cache.


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

Parameters

$key : string: Identifier for the data
$value : mixed: Data to be cached
$ttl : DateInterval|int|null = null: 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.

Return values

bool —

True if the data was successfully cached, false on failure

setConfig()

Sets the config.


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

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

$key : array<string, mixed>|string: The key to set, or a complete array of configs.
$value : mixed|null = null: The value to set.
$merge : bool = true: Whether to recursively merge or overwrite existing config, defaults to true.

Return values

$this

setMultiple()

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


    public
                    setMultiple(iterable<string|int, mixed> $values[, DateInterval|int|null $ttl = null ]) : bool

Parameters

$values : iterable<string|int, mixed>: A list of key => value pairs for a multiple-set operation.
$ttl : DateInterval|int|null = null: 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.

Return values

bool —

True on success and false on failure.

_configDelete()

Deletes a single config key.


    protected
                    _configDelete(string $key) : void

Parameters

$key : string: Key to delete.

_configRead()

Reads a config key.


    protected
                    _configRead(string|null $key) : mixed

Parameters

$key : string|null: Key to read.

_configWrite()

Writes a config key.


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

Parameters

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

_connect()

Connects to a Redis server


    protected
                    _connect() : bool

Return values

bool —

True if Redis server was connected

_key()

Generates a key for cache backend usage.


    protected
                    _key(string $key) : string

If the requested key is valid, the group prefix value and engine prefix are applied. Whitespace in keys will be replaced.

Parameters

$key : string: the key passed over

Return values

string —

Prefixed key with potentially unsafe characters replaced.

duration()

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


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

Parameters

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

Return values

int

ensureValidKey()

Ensure the validity of the given cache key.


    protected
                    ensureValidKey(string $key) : void

Parameters

$key : string: Key to check.

ensureValidType()

Ensure the validity of the argument type and cache keys.


    protected
                    ensureValidType(iterable<string|int, mixed> $iterable[, string $check = self::CHECK_VALUE ]) : void

Parameters

$iterable : iterable<string|int, mixed>: The iterable to check.
$check : string = self::CHECK_VALUE: Whether to check keys or values.

serialize()

Serialize value for saving to Redis.


    protected
                    serialize(mixed $value) : string

This is needed instead of using Redis' in built serialization feature as it creates problems incrementing/decrementing intially set integer value.

Parameters

$value : mixed: Value to serialize.

Return values

string

unserialize()

Unserialize string value fetched from Redis.


    protected
                    unserialize(string $value) : mixed

Parameters

$value : string: Value to unserialize.

warning()

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


    protected
                    warning(string $message) : void

Parameters

$message : string: The warning message.

RedisEngine extends CacheEngine in package Application

Table of Contents

Constants

Properties

Methods

Constants

CHECK_KEY

CHECK_VALUE

Properties

$_config

$_configInitialized

$_defaultConfig

$_groupPrefix

$_Redis

Methods

__destruct()

add()

Parameters

Tags

Return values

clear()

Return values

clearBlocking()

Return values

clearGroup()

Parameters

Return values

configShallow()

Parameters

Return values

decrement()

Parameters

Return values

delete()

Parameters

Return values

deleteAsync()

Parameters

Return values

deleteMultiple()

Parameters

Tags

Return values

get()

Parameters

Return values

getConfig()

Usage

Parameters

Return values

getConfigOrFail()

Parameters

Tags

Return values

getMultiple()

Parameters

Tags

Return values

groups()

Return values

has()

Parameters

Tags

Return values

increment()

Parameters

Return values

init()

Parameters

Return values

set()

Parameters

Return values

setConfig()

Usage

Parameters

Tags

Return values

setMultiple()

Parameters

RedisEngine extends CacheEngine
in package

Application