Класс 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, проверяет срок действия, иначе удаляет все

Возвращает

boolean
True, если кеш успешно очищен, иначе false

clearGroup()source public

clearGroup( string $group )

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

Параметры

строка $group

имя группы, подлежащей очистке

Возвращает

логическое значение

decrement()source abstract public

decrement( string $key , integer $offset 1 )

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

Параметры

строка $key

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

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

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

Возвращает

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

delete()source abstract public

delete( string $key )

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

Параметры

строка $key

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

Возвращает

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

deleteMany()source public

deleteMany( array $keys )

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

Параметры

массив $keys

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

Возвращает

массив

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

gc()source public

gc( integer|null $expires null )

Сбор мусора

Постоянно удаляет все истекшие и удалённые данные

Параметры

целое число|null $expires необязательно null

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

groups()source public

groups( )

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

Возвращает

массив

increment()source abstract public

increment( string $key , integer $offset 1 )

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

Параметры

string $key

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

integer $offset optional 1

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

Возвращает

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

init()source public

init( array $config [] )

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

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

Параметры

array $config optional []

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

Возвращает

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

key()source public

key( string $key )

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

Параметры

string $key

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

Возвращает

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

read()source abstract public

read( string $key )

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

Параметры

string $key

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

Возвращает

mixed
Данные кеша или false, если данных нет, они истекли или произошла ошибка при получении

readMany()source public

readMany( array $keys )

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

Параметры

array $keys

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

Возвращает

array

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

write()source abstract public

write( string $key , mixed $value )

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

Параметры

string $key

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

mixed $value

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

Возвращает

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

writeMany()source public

writeMany( array $data )

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

Параметры

array $data

Массив данных, которые нужно сохранить в кеше

Возвращает

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

_configDelete()source protected

_configDelete( string $key )

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

Параметры

string $key

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

Исключения

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

_configRead()source protected

_configRead( string|null $key )

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

Параметры

string|null $key

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

Возвращает

mixed

_configWrite()source protected

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

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

Параметры

string|array $key

Ключ, которому нужно присвоить значение.

mixed $value

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

boolean|string $merge optional false

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

Исключения

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

config()source public

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() вместо этого.

Параметры

string|array|null $key optional null

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

mixed|null $value optional null

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

boolean $merge optional 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']);

Параметры

string|array $key

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

mixed|null $value optional 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');

Параметры

string|null $key optional null

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

mixed $default optional 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 optional null

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

boolean $merge optional true

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

Возвращает

$this

Исключения

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

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