Класс 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

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

Возвращает

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

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

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

Возвращает

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

deleteMany()source public

deleteMany( array $keys )

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

Параметры

массив $keys

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

Возвращает

массив

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

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

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

Возвращает

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

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

Возвращает

массив
значений boolean для каждого ключа, 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
Данные конфигурации по указанному ключу или 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,
    'warnOnWriteFailures' => true,
]