Класс WincacheEngine

Движок кэширования Wincache для кэша

Поддерживает wincache 1.1.0 и выше.

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

Константы

string

CHECK_KEY
```
'key'
```
string

CHECK_VALUE
```
'value'
```

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

$_compiledGroupNames protected

array<string>

Содержит скомпилированные имена групп (с префиксом глобального конфигурационного префикса)
$_config protected

array<string, mixed>

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

bool

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

array<string, mixed>

Конфигурация кэша по умолчанию переопределяется в большинстве адаптеров кэша. Это ключи, общие для всех адаптеров. Если переопределено, это свойство не используется.
$_groupPrefix protected

string

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

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

_configDelete() protected

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

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

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

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

Добавляет ключ в кэш, если он ещё не существует.
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

Инициализирует движок кэша
set() public

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

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

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

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

END_OF_DOCUMENT_MARKER

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

_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: True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Возвращает

void

Исключения

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

_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

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 необязательный: Значение по умолчанию для ключей, которых нет в кэше.

Возвращает

iterable

Выбрасывает

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

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 необязательный: На сколько увеличить.

Возвращает

int|false

init() public

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

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

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

Параметры

array<string, mixed> $config необязательный: Массив настроек для движка.

Возвращает

bool

set() public

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

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

Параметры

string $key: Идентификатор данных.
mixed $value: Данные для кэширования.
null|intDateInterval $ttl необязательный: Необязательно. Значение 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 необязательный: Значение для установки.
bool $merge необязательный: Выполнять рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию true.

Возвращает

$this

Выбрасывает

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

setMultiple() public

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

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

Параметры

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

Возвращает

bool

Выбрасывает

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

warning() protected

warning(string $message): void

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

Параметры

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

Возвращает

void

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

`$_compiledGroupNames` protected

Содержит скомпилированные имена групп (с префиксом глобальной конфигурации).

Тип

array<string>

`$_config` protected

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

Тип

array<string, mixed>

`$_configInitialized` protected

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

Тип

bool

`$_defaultConfig` protected

Конфигурация кэша по умолчанию переопределяется в большинстве адаптеров кэша. Это ключи, общие для всех адаптеров. Если переопределено, это свойство не используется.

duration Укажите, как долго элементы в этой конфигурации кэша хранятся.
groups Список групп или «тегов», связанных с каждым ключом, хранящимся в этой конфигурации. Удобно для удаления целой группы из кэша.
prefix Префикс, добавляемый ко всем записям. Хорошо подходит, когда вам нужно использовать одно пространство ключей с другой конфигурацией кэша или другим приложением.
warnOnWriteFailures Некоторые движки, такие как ApcuEngine, могут вызывать предупреждения при сбоях записи.

Тип

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.4/class-Cake.Cache.Engine.WincacheEngine.html