Класс CacheEngine

_key()source protected

_key( string $key )

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

Параметры

строка $key

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

Возвращает

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

Выбрасывает

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

add()source public

add( string $key , mixed $value )

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

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

Параметры

строка $key

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

смешанный $value

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

Возвращает

логическое значение
Истина, если данные успешно помещены в кеш, ложь при ошибке.

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 необязательно 1

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

Возвращает

логическое значение|целое число
Новое увеличенное значение, в противном случае ложь

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 необязательно 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

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

Возвращает

массив

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

write()source abstract public

write( string $key , mixed $value )

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

Параметры

строка $key

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

смешанный $value

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

Возвращает

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

writeMany()source public

writeMany( array $data )

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

Параметры

массив $data

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

Возвращает

массив
массив булевых значений для каждого ключа, 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|string $merge необязательно 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']);

Параметры

строка|массив|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->config('key', $value);

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

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

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

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

Параметры

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

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

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

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

Возвращает

$this Объект.

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

null