Класс CacheEngine

_keyисточник protected

_key( string $key )

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

Параметры

строка $key

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

Возвращает

mixed
строка $key или false

Исключение

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

addисточник public

add( string $key , mixed $value )

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

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

Параметры

строка $key

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

смешанный $value

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

Возвращает

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

clearисточник abstract public

clear( boolean $check )

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

Параметры

логическое $check

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

Возвращает

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

clearGroupисточник public

clearGroup( string $group )

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

Параметры

строка $group

имя группы для очистки

Возвращает

boolean
bool

decrementисточник abstract public

decrement( string $key , integer $offset 1 )

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

Параметры

строка $key

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

целое число $offset по желанию 1

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

Возвращает

boolean|integer
Новое уменьшенное значение, иначе false

deleteисточник abstract public

delete( string $key )

Удалить ключ из кэша

Параметры

строка $key

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

Возвращает

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

deleteManyисточник public

deleteMany( array $keys )

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

Параметры

массив $keys

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

Возвращает

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

gcисточник public

gc( integer|null $expires null )

Сбор мусора

Постоянно удаляет все просроченные и удаленные данные

Параметры

целое число|null $expires по желанию null

[по желанию] Отметка времени истечения срока действия, делающая все данные, предшествующие ей, недопустимыми.

groupsисточник public

groups( )

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

Возвращает

array
массив

incrementисточник abstract public

increment( string $key , integer $offset 1 )

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

Параметры

строка $key

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

целое число $offset по желанию 1

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

Возвращает

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

initисточник public

init( array $config [] )

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

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

Параметры

массив $config по желанию []

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

Возвращает

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

keyисточник public

key( string $key )

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

Параметры

строка $key

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

Возвращает

boolean|string
строка ключ или false

readисточник abstract public

read( string $key )

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

Параметры

строка $key

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

Возвращает

mixed
Кэшированные данные или false, если данных нет, истек срок действия или произошла ошибка при извлечении

readManyисточник public

readMany( array $keys )

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

Параметры

массив $keys

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

Возвращает

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

writeисточник abstract public

write( string $key , mixed $value )

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

Параметры

строка $key

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

смешанный $value

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

Возвращает

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

writeManyисточник public

writeMany( array $data )

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

Параметры

массив $data

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

Возвращает

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

_configDeletesource protected

_configDelete( string $key )

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

Параметры

строка $key

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

Исключения

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

_configReadsource protected

_configRead( string|null $key )

Чтение переменной конфигурации

Параметры

строка|null $key

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

Возвращает

mixed
смешанный тип

_configWritesource protected

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

Запись переменной конфигурации

Параметры

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

Ключ для записи.

смешанный тип $value

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

логическое значение|строка $merge необязательно false

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

Исключения

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

configsource 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

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

логическое значение $merge необязательно true

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

Возвращает

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

Исключения

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

configShallowsource 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

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

Возвращает

mixed
Сам объект.

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

null

[]

false