Класс CacheEngine

_key()source protected

_key( string $key )

Генерирует безопасный ключ, учитывая настроенный префикс ключа

Параметры

строка $key

переданный ключ

Возвращает

смешанный
строка $key или false

Выбрасывает

InvalidArgumentException
Если значение ключа пустое

add()source public

add( string $key , mixed $value )

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

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

Параметры

строка $key

Идентификатор данных.

смешанный $value

Данные, которые нужно кэшировать.

Возвращает

логическое
True, если данные были успешно кэшированы, false при ошибке.

clear()source abstract public

clear( boolean $check )

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

Параметры

логическое $check

если true, будет проверка истечения срока действия, иначе удаление всех

Возвращает

логическое
True, если кэш был успешно очищен, иначе false

clearGroup()source public

clearGroup( string $group )

Очищает все значения, принадлежащие группе. Реализующему движку предоставляется право решать, действительно удалять ключи или просто моделировать это для достижения того же результата.

Параметры

строка $group

имя группы для очистки

Возвращает

логическое

decrement()source abstract public

decrement( string $key , integer $offset = 1 )

Уменьшает число по ключу и возвращает уменьшенное значение

Параметры

строка $key

Идентификатор данных

целое $offset optional 1

На сколько уменьшить

Возвращает

логическое|целое
Новое уменьшенное значение, иначе false

delete()source abstract public

delete( string $key )

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

Параметры

строка $key

Идентификатор данных

Возвращает

логическое
True, если значение было успешно удалено, false, если его не существовало или не удалось удалить

deleteMany()source public

deleteMany( array $keys )

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

Параметры

массив $keys

Массив идентификаторов данных

Возвращает

массив

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

gc()source public

gc( integer|null $expires = null )

Сбор мусора

Постоянно удаляет все просроченные и удалённые данные

Параметры

целое|null $expires optional null

[необязательно] Маркер времени истечения срока действия, делая все данные до него недействительными.

groups()source public

groups( )

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

Возвращает

массив

increment()source abstract public

increment( string $key , integer $offset = 1 )

Увеличить число по ключу и вернуть увеличенное значение

Параметры

строка $key

Идентификатор данных

целое число $offset необязательно 1

На сколько увеличить

Возвращает

boolean|integer
Новое увеличенное значение, иначе false

init()source public

init( array $config = [] )

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

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

Параметры

массив $config необязательно []

Ассоциативный массив параметров для движка

Возвращает

boolean
True, если движок был успешно инициализирован, иначе false

key()source public

key( string $key )

Генерирует безопасный ключ для использования с движками хранения кеша.

Параметры

строка $key

переданный ключ

Возвращает

boolean|string
строковый ключ или false

read()source abstract public

read( string $key )

Прочитать ключ из кэша

Параметры

строка $key

Идентификатор данных

Возвращает

mixed
Данные кэша или false, если данные не существуют, истекли срок действия или произошла ошибка при их извлечении

readMany()source public

readMany( array $keys )

Прочитать несколько ключей из кэша

Параметры

массив $keys

Массив идентификаторов данных

Возвращает

array

Для каждого ключа кэша (указанного в качестве ключа массива) соответствующие данные кэша или false, если данные не существуют, истекли срок действия или произошла ошибка при их извлечении

warning()source protected

warning( string $message )

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

Параметры

строка $message

Сообщение предупреждения.

write()source abstract public

write( string $key , mixed $value )

Записать значение для ключа в кеш

Параметры

строка $key

Идентификатор данных

смешанное $value

Данные для кеширования

Возвращает

boolean
True, если данные были успешно помещены в кэш, false в случае ошибки

writeMany()source public

writeMany( array $data )

Записать данные для многих ключей в кеш

Параметры

массив $data

Массив данных для хранения в кэше

Возвращает

array
массив булевых значений для каждого ключа, true, если данные были успешно помещены в кэш, false в случае ошибки

_configDelete()source protected

_configDelete( string $key )

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

Параметры

строка $key

Ключ для удаления.

Выбрасывает

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

_configRead()source protected

_configRead( string|null $key )

Считывает ключ конфигурации.

Параметры

строка|null $key

Ключ для чтения.

Возвращает

mixed

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge = false )

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

Параметры

строка|массив $key

Ключ для записи.

смешанное $value

Значение для записи.

boolean|строка $merge необязательно false

True для рекурсивного объединения, 'shallow' для простого объединения, false для перезаписи, по умолчанию false.

Выбрасывает

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

config()source public deprecated

config( string|array|null $key = null , mixed|null $value = null , boolean $merge = true )

Получение/Установка конфигурации.

Использование

Чтение всей конфигурации:

$this->config();

Чтение определенного значения:

$this->config('key');

Чтение вложенного значения:

$this->config('some.nested.key');

Установка определенного значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Устаревшее

3.4.0 используйте setConfig()/getConfig() вместо этого.

Параметры

строка|массив|null $key необязательно null

Ключ для получения/установки или полный массив конфигураций.

смешанное|null $value необязательно null

Значение для установки.

boolean $merge необязательно true

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

Возвращает

mixed
Значение конфигурации, которое считывается, или сам объект при операциях записи.

Выбрасывает

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

configShallow()source public

configShallow( string|array $key , mixed|null $value = null )

Объединить предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), которая выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.

Установка определенного значения:

$this->configShallow('key', $value);

Установка вложенного значения:

$this->configShallow('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Параметры

строка|массив $key

Ключ для установки или полный массив конфигураций.

смешанное|null $value необязательно null

Значение для установки.

Возвращает

$this

getConfig()source public

getConfig( string|null $key = null , mixed $default = null )

Возвращает конфигурацию.

Использование

Чтение всей конфигурации:

$this->getConfig();

Чтение определенного значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

строка|null $key необязательно null

Ключ для получения или null для всей конфигурации.

смешанное $default необязательно null

Значение по умолчанию, если ключ не существует.

Возвращает

mixed
Значение конфигурации, которое считывается.

setConfig()source public

setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )

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

Использование

Установка конкретного значения:

$this->setConfig('key', $value);

Установка вложенного значения:

$this->setConfig('some.nested.key', $value);

Обновление нескольких параметров конфигурации одновременно:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key

Ключ для установки или полный массив конфигураций.

mixed|null $value необязательно null

Значение для установки.

boolean $merge необязательно true

Выполнять рекурсивное слияние или перезапись существующей конфигурации, по умолчанию — true.

Возвращает

$this

Выбрасывает

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

[
    'duration' => 3600,
    'groups' => [],
    'prefix' => 'cake_',
    'probability' => 100,
    'warnOnWriteFailures' => true,
]