Интерфейс CacheEngineInterface
Интерфейс для движков кеширования, определяющий методы за пределами интерфейса PSR16, используемые Cache.
Внутренне Cache использует этот интерфейс при вызове методов движка.
Прямые реализаторы
Краткое описание методов
- add() publicЗаписать данные для ключа в движок кеширования, если они ещё не существуют.
- clearGroup() publicОчистить все значения, относящиеся к заданной группе.
- decrement() publicУменьшить число по ключу и вернуть уменьшенное значение
- increment() publicУвеличить число по ключу и вернуть увеличенное значение
Подробное описание методов
add()source public
add( string $key , mixed $value )
Записать данные для ключа в движок кеширования, если они ещё не существуют.
Параметры
- string
$key - Идентификатор данных.
- mixed
$value - Данные для кеширования — всё, кроме ресурса.
Возвращаемое значение
booleanTrue, если данные успешно кешированы, false — при ошибке. Или если ключ уже существовал.
clearGroup()source public
clearGroup( string $group )
Очистить все значения, относящиеся к заданной группе.
Каждая реализация должна решить, действительно ли удалять ключи или просто увеличить значение генерации группы, чтобы добиться того же результата.
Параметры
- string
$group - название группы для очистки
Возвращаемое значение
booleandecrement()source public
decrement( string $key , integer $offset = 1 )
Уменьшить число по ключу и вернуть уменьшенное значение
Параметры
- string
$key - Идентификатор данных
- integer
$offsetoptional 1 - На сколько уменьшить
Возвращаемое значение
boolean|integerНовое уменьшенное значение, false в противном случае
increment()source public
increment( string $key , integer $offset = 1 )
Увеличить число по ключу и вернуть увеличенное значение
Параметры
- string
$key - Идентификатор данных
- integer
$offsetoptional 1 - На сколько увеличить
Возвращаемое значение
boolean|integerНовое увеличенное значение, false в противном случае
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.8/class-Cake.Cache.CacheEngineInterface.html