Класс CacheEngine

_key()source protected

_key( string $key )

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

Параметры

строка $key

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

Возвращает

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

Исключения

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

add()source public

add( string $key , mixed $value )

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

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

Параметры

строка $key

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

смешанный $value

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

Возвращает

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

clear()source abstract public

clear( boolean $check )

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

Параметры

boolean $check

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

Возвращает

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

clearGroup()source public

clearGroup( string $group )

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

Параметры

строка $group

название группы, подлежащей очистке

Возвращает

boolean

decrement()source abstract public

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

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

Параметры

строка $key

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

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

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

Возвращает

boolean|целое число
Новое увеличенное значение, 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 )

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

Параметры

строка $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, если данных нет, срок действия истек или возникла ошибка при их получении

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

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

Возвращаемое значение

массив
массив булевых значений для каждого заданного ключа, 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 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.

Возвращаемое значение

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

Исключения

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

Параметры

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