Класс CacheEngine

_key()source protected

_key( string $key )

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

Параметры

string $key

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

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

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

Исключения

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

add()source public

add( string $key , mixed $value )

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

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

Параметры

string $key

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

mixed $value

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

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

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

clear()source abstract public

clear( boolean $check )

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

Параметры

boolean $check

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

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

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

clearGroup()source public

clearGroup( string $group )

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

Параметры

string $group

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

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

boolean

decrement()source abstract public

decrement( string $key , integer $offset 1 )

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

Параметры

string $key

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

integer $offset optional 1

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

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

boolean|integer
Новое уменьшенное значение, false в противном случае

delete()source abstract public

delete( string $key )

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

Параметры

string $key

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

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

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

deleteMany()source public

deleteMany( array $keys )

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

Параметры

array $keys

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

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

array

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

gc()source public

gc( integer|null $expires null )

Сбор мусора

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

Параметры

integer|null $expires optional null

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

groups()source public

groups( )

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

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

array

increment()source abstract public

increment( string $key , integer $offset 1 )

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

Параметры

string $key

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

integer $offset optional 1

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

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

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

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

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

mixed
Данные из кеша или false, если данных нет, они просрочены или произошла ошибка при чтении

readMany()source public

readMany( array $keys )

Чтение нескольких ключей из кеша

Параметры

массив $keys

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

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

массив

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

write()source abstract public

write( string $key , mixed $value )

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

Параметры

строка $key

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

mixed $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

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

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

Параметры

строка|массив|null $key необязательно null

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

mixed|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

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

mixed|null $value необязательно null

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

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

$this Объект самого себя.

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

null