Класс RedisEngine

Двигатель хранения Redis для кэша.

Пространство имён: Cake\Cache\Engine

Константы

string

CHECK_KEY
```
'key'
```
string

CHECK_VALUE
```
'value'
```

Краткое описание свойств

$_Redis protected

Redis

Обёртка Redis.
$_config protected

array

Конфигурация выполнения
$_configInitialized protected

bool

Указатель того, была ли конфигурация уже настроена по умолчанию
$_defaultConfig protected

array

Конфигурация по умолчанию, используемая, если не переопределена конфигурацией выполнения
$_groupPrefix protected

string

Содержит скомпилированную строку со всеми префиксами групп, которые должны быть добавлены перед каждым ключом в этом кэше

Краткое описание методов

__destruct() public

Отключается от сервера redis
_configDelete() protected

Удаляет один ключ конфигурации.
_configRead() protected

Читает ключ конфигурации.
_configWrite() protected

Записывает ключ конфигурации.
_connect() protected

Подключается к серверу Redis
_key() protected

Генерирует ключ для использования кэш-бекендом.
add() public

Записать данные для ключа в кэш, если он ещё не существует. Если он уже существует, произойдёт ошибка и вернётся false.
clear() public

Удалить все ключи из кэша
clearGroup() public

Увеличивает значение группы, чтобы смоделировать удаление всех ключей в группе; старые значения останутся в хранилище, пока не истечёт срок их действия.
configShallow() public

Объединяет предоставленную конфигурацию с существующей. В отличие от config(), которое выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.
decrement() public

Уменьшает значение целочисленного кэшированного ключа и обновляет срок действия
delete() public

Удалить ключ из кэша
deleteMultiple() public

Удаляет несколько элементов кэша в одной операции.
duration() protected

Преобразует различные выражения значения TTL в продолжительность в секундах
ensureValidKey() protected

Обеспечивает корректность предоставленного ключа кэша.
ensureValidType() protected

Обеспечивает корректность типа аргумента и ключей кэша.
get() public

Прочитать ключ из кэша
getConfig() public

Возвращает конфигурацию.
getConfigOrFail() public

Возвращает конфигурацию для этого конкретного ключа.
getMultiple() public

Получает несколько элементов кэша по уникальным ключам.
groups() public

Возвращает значения group value для каждой из настроенных групп. Если начальное значение группы не найдено, то группа инициализируется соответствующим образом.
has() public

Определяет, присутствует ли элемент в кэше.
increment() public

Увеличивает значение целочисленного кэшированного ключа и обновляет срок действия
init() public

Инициализировать кэш-движок
serialize() protected

Сериализовать значение для сохранения в Redis.
set() public

Записать данные для ключа в кэш.
setConfig() public

Устанавливает конфигурацию.
setMultiple() public

Сохраняет набор пар ключ => значение в кэше с необязательным TTL.
unserialize() protected

Десериализовать строковое значение, полученное из Redis.
warning() protected

Двигатели кэша могут генерировать предупреждения, если они сталкиваются с ошибками во время работы, если опция warnOnWriteFailures установлена в true.

END_OF_DOCUMENT_MARKER ```

Подробное описание методов

__destruct() public

__destruct()

Отключение от сервера redis

_configDelete() protected

_configDelete(string $key): void

Удаляет один ключ конфигурации.

Параметры

string $key: Ключ для удаления.

Возвращает

void

Исключения

Cake\Core\Exception\CakeException
при попытке перезаписать существующую конфигурацию

_configRead() protected

_configRead(string|null $key): mixed

Чтение ключа конфигурации.

Параметры

string|null $key: Ключ для чтения.

Возвращает

mixed

_configWrite() protected

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

Запись ключа конфигурации.

Параметры

string|array $key: Ключ для записи.
mixed $value: Значение для записи.
bool|string $merge optional: Истина для рекурсивного слияния, 'shallow' для простого слияния, ложь для перезаписи, по умолчанию ложь.

Возвращает

void

Исключения

Cake\Core\Exception\CakeException
при попытке перезаписать существующую конфигурацию

_connect() protected

_connect(): bool

Подключение к серверу Redis

Возвращает

bool

_key() protected

_key(string $key): string

Генерирует ключ для использования кэшем бэкендом.

Если запрашиваемый ключ допустимый, применяются значение префикса группы и префикса движка. Пробелы в ключах будут заменены.

Параметры

string $key: переданный ключ

Возвращает

string

Исключения

Cake\Cache\InvalidArgumentException
Если значение ключа недопустимо.

add() public

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

Записывает данные для ключа в кэш, если он еще не существует. Если он уже существует, происходит отказ и возвращается ложь.

По умолчанию используется неатомарная реализация. Подклассы должны предпочитать атомарные реализации.

Параметры

string $key: Идентификатор данных.
mixed $value: Данные, которые будут помещены в кэш.

Возвращает

bool

Ссылки

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

clear() public

clear(): bool

Удаляет все ключи из кэша

Возвращает

bool

clearGroup() public

clearGroup(string $group): bool

Увеличивает значение группы, чтобы имитировать удаление всех ключей в группе. Старые значения останутся в хранилище до истечения срока их действия.

Каждая реализация должна решить, удалять ли фактически ключи или просто увеличить значение генерации группы, чтобы добиться того же результата.

Параметры

string $group: имя группы, которая должна быть очищена

Возвращает

bool

configShallow() public

configShallow(string|array $key, mixed|null $value = null): $this

Объединяет предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), которая выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

Установка определенного значения:

$this->configShallow('key', $value);

Установка вложенного значения:

$this->configShallow('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key: Ключ для установки или полный массив конфигураций.
mixed|null $value optional: Значение для установки.

Возвращает

$this

decrement() public

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

Уменьшает значение целого числового кэшированного ключа и обновляет срок действия.

Параметры

string $key: Идентификатор данных
int $offset optional: На сколько уменьшить

Возвращает

int|false

delete() public

delete(string $key): bool

Удаляет ключ из кэша

Параметры

string $key: Идентификатор данных

Возвращает

bool

deleteMultiple() public

deleteMultiple(iterable $keys): bool

Удаляет несколько элементов кэша за одну операцию.

Параметры

iterable $keys: Список ключей на основе строк, которые должны быть удалены.

Возвращает

bool

Исключения

Cake\Cache\InvalidArgumentException
Если $keys не является массивом или Traversable, или если какой-либо из $keys не является допустимым значением.

duration() protected

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

Преобразует различные выражения значения TTL в продолжительность в секундах

Параметры

DateInterval|int|null $ttl: Значение TTL данного элемента. Если отправлен null, будет использоваться значение по умолчанию драйвера.

Возвращает

int

ensureValidKey() protected

ensureValidKey(string $key): void

Проверка допустимости заданного ключа кэша.

Параметры

string $key: Ключ для проверки.

Возвращает

void

Исключения

Cake\Cache\InvalidArgumentException
При недопустимости ключа.

ensureValidType() protected

ensureValidType(iterable $iterable, string $check = self::CHECK_VALUE): void

Проверка допустимости типа аргумента и ключей кэша.

Параметры

iterable $iterable: Проверяемый объект.
string $check optional: Проверять ключи или значения.

Возвращает

void

Исключения

Cake\Cache\InvalidArgumentException

get() public

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

Чтение ключа из кэша

Параметры

string $key: Идентификатор данных
mixed $default optional: Значение по умолчанию для возврата, если ключ не существует.

Возвращает

mixed

getConfig() public

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

Возвращает конфигурацию.

Использование

Чтение всей конфигурации:

$this->getConfig();

Чтение определенного значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

string|null $key optional: Ключ для получения или null для всей конфигурации.
mixed $default optional: Значение для возврата, когда ключ не существует.

Возвращает

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

Возвращает конфигурацию для конкретного ключа.

Значение конфигурации для данного ключа должно существовать, оно никогда не может быть null.

Параметры

string $key: Ключ для получения.

Возвращает

mixed

Исключения

InvalidArgumentException

getMultiple() public

getMultiple(iterable $keys, mixed $default = null): iterable

Получает несколько элементов кэша по их уникальным ключам.

Параметры

iterable $keys: Список ключей, которые можно получить в одной операции.
mixed $default optional: Значение по умолчанию для ключей, которых нет.

Возвращает

iterable

Выбрасывает

groups() public

groups(): string[]

Возвращает group value для каждой из настроенных групп. Если начальное значение группы не найдено, группа инициализируется соответствующим образом.

Возвращает

string[]

has() public

has(string $key): bool

Определяет, присутствует ли элемент в кэше.

ПРИМЕЧАНИЕ: рекомендуется использовать has() только для целей подготовки кэша, а не для использования в операциях get/set в ваших приложениях реального времени, так как этот метод подвержен проблеме гонки, когда has() вернет true, а сразу после этого другой скрипт может удалить его, делая состояние вашего приложения неактуальным.

Параметры

string $key: Ключ элемента кэша.

Возвращает

bool

Выбрасывает

Cake\Cache\InvalidArgumentException
Если строка $key не является допустимым значением.

increment() public

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

Увеличивает значение целочисленного ключа кэша и обновляет время истечения срока действия

Параметры

string $key: Идентификатор данных
int $offset optional: На сколько увеличить

Возвращает

int|false

init() public

init(array $config = []): bool

Инициализировать движок кэширования

Вызывается автоматически фронтом кэша

Параметры

array $config optional: массив настроек для движка

Возвращает

bool

serialize() protected

serialize(mixed $value): string

Сериализация значения для сохранения в Redis.

Это необходимо вместо использования встроенной функции сериализации Redis, так как она создает проблемы с увеличением/уменьшением первоначально установленного целочисленного значения.

Параметры

mixed $value: Значение для сериализации.

Возвращает

string

Ссылки

https://github.com/phpredis/phpredis/issues/81

set() public

set(string $key, mixed $value, null|intDateInterval $ttl = null): bool

Записать данные для ключа в кэш.

Параметры

string $key: Идентификатор данных
mixed $value: Данные, которые нужно кэшировать
null|intDateInterval $ttl optional: Необязательно. Значение TTL этого элемента. Если значение не отправлено, и драйвер поддерживает TTL, библиотека может установить для него значение по умолчанию или позволить драйверу позаботиться об этом.

Возвращает

bool

setConfig() public

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

Устанавливает конфигурацию.

Использование

Установка определенного значения:

$this->setConfig('key', $value);

Установка вложенного значения:

$this->setConfig('some.nested.key', $value);

Обновление нескольких параметров конфигурации одновременно:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key: Ключ для установки или полный массив конфигураций.
mixed|null $value optional: Значение для установки.
bool $merge optional: Требуется ли рекурсивно слияние или перезапись существующей конфигурации, по умолчанию true.

Возвращает

$this

Выбрасывает

Cake\Core\Exception\CakeException
При попытке установить недопустимый ключ.

setMultiple() public

setMultiple(iterable $values, null|intDateInterval $ttl = null): bool

Сохраняет набор пар ключ => значение в кэше с необязательным TTL.

Параметры

iterable $values: Список пар ключ => значение для операции множественного задания.
null|intDateInterval $ttl optional: Необязательно. Значение TTL этого элемента. Если значение не отправлено, и драйвер поддерживает TTL, библиотека может установить для него значение по умолчанию или позволить драйверу позаботиться об этом.

Возвращает

bool

Выбрасывает

Cake\Cache\InvalidArgumentException
Если $values не является массивом или Traversable, или если какое-либо из $values не является допустимым значением.

unserialize() protected

unserialize(string $value): mixed

Десериализация строкового значения, полученного из Redis.

Параметры

string $value: Значение для десериализации.

Возвращает

mixed

warning() protected

warning(string $message): void

Движки кэша могут генерировать предупреждения, если во время операции возникают сбои, если параметр warnOnWriteFailures установлен в true.

Параметры

string $message: Сообщение о предупреждении.

Возвращает

void

Подробное описание свойств

`$_Redis` protected

Обёртка Redis.

Тип

Redis

`$_config` protected

Конфигурация во время выполнения

Тип

array

`$_configInitialized` protected

Установлена ли конфигурация свойства со значениями по умолчанию

Тип

bool

`$_defaultConfig` protected

Конфигурация по умолчанию, используемая, если не переопределена конфигурацией во время выполнения

database номер базы данных для подключения.
duration Указывает, как долго элементы в этой конфигурации кэша сохраняются.
groups Список групп или «меток», связанных с каждым ключом, хранящимся в этой конфигурации. Полезно для удаления целой группы из кэша.
password Пароль сервера Redis.
persistent Подключение к серверу Redis с постоянным подключением
port Порт сервера Redis.
prefix Префикс, добавляемый ко всем записям. Подходит для случаев, когда необходимо совместно использовать пространство имён ключей с другой конфигурацией кэша или другим приложением.
server URL или IP-адрес хоста сервера Redis.
timeout таймаут в секундах (число с плавающей точкой).
unix_socket Путь к файлу сокета Unix (по умолчанию: false)

Тип

array

`$_groupPrefix` protected

Содержит скомпилированную строку со всеми префиксами групп, которые необходимо добавить к каждому ключу в этом движке кэша

Тип

string

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.2/class-Cake.Cache.Engine.RedisEngine.html