Класс WincacheEngine

Двигатель кэширования Wincache для кэша

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

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

Константы

string

CHECK_KEY
```
'key'
```
string

CHECK_VALUE
```
'value'
```

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

$_compiledGroupNames protected

array

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

array

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

bool

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

array

В большинстве адаптеров кэша конфигурация по умолчанию переопределяется. Эти ключи являются общими для всех адаптеров. Если переопределены, то это свойство не используется.
$_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.

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

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

Возвращает

void

Исключения

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

_key() protected

_key(string $key): string

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

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

Параметры

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(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 опционально: Значение для установки.

Возвращает

$this

decrement() public

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

Уменьшает значение целочисленного ключа в кэше

Параметры

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

Возвращает

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 опционально: Проверять ключи или значения.

Возвращает

void

Исключения

Cake\Cache\InvalidArgumentException

get() public

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

Считывает значение из кэша по ключу.

Параметры

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

Возвращает

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 опционально: Ключ для получения или null для всей конфигурации.
mixed $default опционально: Значение по умолчанию, если ключ не существует.

Возвращает

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

Выбрасывает

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

Возвращает

int|false

init() public

init(array $config = []): bool

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

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

Параметры

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

`$_config` protected

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

Тип

array

`$_configInitialized` protected

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

Тип

bool

`$_defaultConfig` protected

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

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

Тип

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.WincacheEngine.html