Класс RedisEngine

Движок хранения Redis для кэша.

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

Константы

string

CHECK_KEY
```
'key'
```
string

CHECK_VALUE
```
'value'
```

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

$_Redis protected

Redis

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

array<string, mixed>

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

bool

Указывает, была ли свойство config уже настроена с значениями по умолчанию
$_defaultConfig protected

array<string, mixed>

Конфигурация по умолчанию, используемая, если не переопределена конфигурацией во время выполнения
$_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(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

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

Параметры

array<string, mixed>|string $key: Ключ для записи.
mixed $value: Значение для записи.
string|bool $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(array<string, mixed>|string $key, mixed|null $value = null): $this

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

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

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

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

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

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

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

Параметры

array<string, mixed>|string $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(): array<string>

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

Возвращает

array<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<string, mixed> $config = []): bool

Инициализирует движок кэша.

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

Параметры

array<string, mixed> $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(array<string, mixed>|string $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']);

Параметры

array<string, mixed>|string $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<string, mixed>

`$_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<string, mixed>

`$_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.3/class-Cake.Cache.Engine.RedisEngine.html