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

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

groups()source public

groups( )

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

Возвращает

массив

increment()source abstract public

increment( string $key , integer $offset 1 )

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

Параметры

строка $key

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

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

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

Возвращает

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

init()source public

init( array $config [] )

Инициализация движка кэша

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

Параметры

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

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

Возвращает

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

key()source public

key( string $key )

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

Параметры

строка $key

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

Возвращает

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

read()source abstract public

read( string $key )

Чтение ключа из кэша

Параметры

строка $key

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

Возвращает

смешанное
Данные кэша или 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

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

Возвращает

смешанное

_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

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.

Возвращает

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

Исключения

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

Возвращаемое значение, если ключ не существует.

Возвращает

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

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']);

Параметры

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

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

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

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

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

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

Возвращает

$this

Исключения

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

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