Класс ArrayEngine

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

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

Пространство имен: 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

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

array<string, array>

Кэшированные данные.

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

_configDelete() protected

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

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

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

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

Добавляет ключ в кэш, если он еще не существует.
clear() public

Удаляет все ключи из кэша. Это очистит каждую конфигурацию кэша, использующую APC.
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: Истина для рекурсивного слияния, '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

Удаляет все ключи из кэша. Это очистит каждую конфигурацию кэша, используя APC.

Возвращает

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

Исключения

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 optional: На сколько увеличить

Возвращает

int|false

init() public

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

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

Вызывается автоматически фронтендом кэша. Объединяет конфигурацию выполнения со значениями по умолчанию перед использованием.

Параметры

array<string, mixed> $config optional: Ассоциативный массив параметров для движка

Возвращает

bool

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 не является допустимым значением.

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

`$data` protected

Данные кэша.

Структурированы как [ключ => [exp => истечение, val => значение]]

Тип

array<string, array>

© 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.ArrayEngine.html