Класс ApcuEngine

Движок кэша APCu

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

Константы

string

CHECK_KEY
```
'key'
```
string

CHECK_VALUE
```
'value'
```

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

$_compiledGroupNames protected

string[]

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

array

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

bool

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

array

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

string

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

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

_configDelete() protected

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

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

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

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

Записывает данные для ключа в кэш, если он еще не существует. Если он уже существует, операция завершается с ошибкой и возвращает false.
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.

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

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

Записывает данные для ключа в кэш, если они еще не существуют. В противном случае возвращает false.

По умолчанию используется неатомарная реализация. Подклассы должны предпочитать атомарные реализации.

Параметры

string $key: Идентификатор данных.
mixed $value: Данные для кеширования.

Возвращает

bool

Ссылки

https://secure.php.net/manual/en/function.apcu-add.php

clear() public

clear(): bool

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

Возвращает

bool

Ссылки

https://secure.php.net/manual/en/function.apcu-cache-info.php

https://secure.php.net/manual/en/function.apcu-delete.php

clearGroup() public

clearGroup(string $group): bool

Увеличивает значение группы для имитации удаления всех ключей в группе. Старые значения останутся в хранилище до истечения срока действия.

Каждая реализация должна решить, действительно ли удалять ключи или просто увеличить значение генерации группы для достижения того же результата.

Параметры

string $group: Группа для очистки.

Возвращает

bool

Ссылки

https://secure.php.net/manual/en/function.apcu-inc.php

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

Возвращает

$this

decrement() public

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

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

Параметры

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

Возвращает

int|false

Ссылки

https://secure.php.net/manual/en/function.apcu-dec.php

delete() public

delete(string $key): bool

Удаляет ключ из кэша.

Параметры

string $key: Идентификатор данных

Возвращает

bool

Ссылки

https://secure.php.net/manual/en/function.apcu-delete.php

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

Ссылки

https://secure.php.net/manual/en/function.apcu-fetch.php

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

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

Возвращает

string[]

Ссылки

https://secure.php.net/manual/en/function.apcu-fetch.php

https://secure.php.net/manual/en/function.apcu-store.php

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

Ссылки

https://secure.php.net/manual/en/function.apcu-inc.php

init() public

init(array $config = []): bool

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

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

Параметры

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

Ссылки

https://secure.php.net/manual/en/function.apcu-store.php

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

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

`$_compiledGroupNames` protected

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

Тип

string[]

`$_config` protected

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

Тип

array

`$_configInitialized` protected

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

Тип

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