Класс NullEngine

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

Используется внутренне, когда был вызван Cache::disable().

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

Константы

string

CHECK_KEY
```
'key'
```
string

CHECK_VALUE
```
'value'
```

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

$_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

Сохраняет данные в кэше, уникально идентифицированные заданным ключом с необязательным временем истечения TTL.
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 необязательно: Истина для рекурсивного слияния, 'shallow' для простого слияния, ложь для перезаписи, по умолчанию ложь.

Возвращает

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

Возвращает

$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

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

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

Возвращает

array<string>

has() public

has(string $key): bool

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

ПРИМЕЧАНИЕ: рекомендуется использовать has() только для целей подготовки кэша и не использовать его в операциях получения/записи в ваших активных приложениях, так как этот метод подвержен гонке, где 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

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

Параметры

string $key
mixed $value
null|intDateInterval $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 необязательно

Возвращает

bool

warning() protected

warning(string $message): void

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

Параметры

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

Возвращает

void

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

`$_config` protected

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

Тип

array<string, mixed>

`$_configInitialized` protected

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

Тип

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