Класс SimpleCacheEngine

__construct()source public

__construct( Cake\Cache\CacheEngine $innerEngine )

Конструктор

Параметры

Cake\Cache\CacheEngine $innerEngine

Декорированный движок.

add()source public

add( string $key , mixed $value )

Запись данных для ключа в движок кеша, если он ещё не существует.

Параметры

строка $key

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

смешанный $value

Данные для кеширования - всё, кроме ресурса.

Возвращает

boolean

True, если данные успешно кешированы, false при ошибке. Или если ключ уже существовал.

Реализация

Cake\Cache\CacheEngineInterface::add()

clear()source public

clear( )

Очистка всех ключей кеша.

Возвращает

boolean
True при успехе и false при ошибке.

clearGroup()source public

clearGroup( string $group )

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

Параметры

строка $group

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

Возвращает

boolean

Реализация

Cake\Cache\CacheEngineInterface::clearGroup()

decrement()source public

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

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

Параметры

строка $key

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

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

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

Возвращает

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

Реализация

Cake\Cache\CacheEngineInterface::decrement()

delete()source public

delete( string $key )

Удаление элемента из кеша по уникальному ключу.

Параметры

строка $key

Уникальный ключ кешируемого элемента для удаления.

Возвращает

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

Вызывает исключение

Cake\Cache\InvalidArgumentException
Если строка $key не является допустимым значением.

deleteMultiple()source public

deleteMultiple( iterable $keys )

Удаление нескольких элементов кеша в одной операции.

Параметры

итерируемый $keys

Список ключей, основанных на строках, для удаления.

Возвращает

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

Вызывает исключение

Cake\Cache\InvalidArgumentException

Если $keys не является массивом или итерируемым объектом, или если любой из $keys не является допустимым значением.

ensureValidKey()source protected

ensureValidKey( string $key )

Проверка валидности заданного ключа кеша.

Параметры

строка $key

Ключ для проверки.

Вызывает исключение

Cake\Cache\InvalidArgumentException
При невалидном ключе.

ensureValidKeys()source protected

ensureValidKeys( mixed $keys )

Проверка валидности заданных ключей кеша.

Параметры

смешанный $keys

Ключи для проверки.

Вызывает исключение

Cake\Cache\InvalidArgumentException
При невалидных ключах.

get()source public

get( string $key , mixed $default = null )

Получение значения по заданному ключу из кеша.

Параметры

строка $key

Уникальный ключ этого элемента в кеше.

смешанный $default необязательно null

Значение по умолчанию, возвращаемое в случае отсутствия ключа.

Возвращает

смешанный
Значение элемента из кеша или $default в случае промаха кеша.

Вызывает исключение

Cake\Cache\InvalidArgumentException
Если строка $key не является допустимым значением.

getMultiple()source public

getMultiple( iterable $keys , mixed $default = null )

Получение нескольких элементов кеша по уникальным ключам.

Параметры

итерируемый $keys

Список ключей, которые могут быть получены в одной операции.

смешанный $default необязательно null

Значение по умолчанию для ключей, которые не существуют.

Возвращает

итерируемый
Список пар "ключ => значение". Ключи кеша, которые не существуют или устарели, будут иметь значение $default.

Вызывает исключение

Cake\Cache\InvalidArgumentException

Если $keys не является массивом или итерируемым объектом, или если любой из $keys не является допустимым значением.

has()source public

has( string $key )

Определяет, присутствует ли элемент в кэше.

ПРИМЕЧАНИЕ: рекомендуется использовать has() только для целей разогрева кэша, а не в операциях get/set в ваших активных приложениях, так как этот метод подвержен гонке, где has() вернёт true, а сразу после этого другой скрипт удалит его, что сделает состояние вашего приложения неактуальным.

Параметры

строка $key

Ключ кэшируемого элемента.

Возвращает

boolean

Возможные исключения

Cake\Cache\InvalidArgumentException
Если строка $key не является допустимым значением.

increment()source public

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

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

Параметры

строка $key

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

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

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

Возвращает

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

Реализация

Cake\Cache\CacheEngineInterface::increment()

set()source public

set( string $key , mixed $value , null|integer|DateInterval $ttl = null )

Сохраняет данные в кэше, уникально ссылающиеся на заданный ключ с необязательным временем истечения TTL.

Параметры

строка $key

Ключ хранимого элемента.

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

Значение хранимого элемента, должно быть сериализуемым.

null|целое число|DateInterval $ttl необязательно null

Необязательно. Значение TTL этого элемента. Если значение не отправлено, и драйвер поддерживает TTL, библиотека может установить для него значение по умолчанию или позволить драйверу позаботиться об этом.

Возвращает

boolean
Истина при успехе и ложь при неудаче.

Возможные исключения

Cake\Cache\InvalidArgumentException
ОБЯЗАТЕЛЬНО должно быть брошено, если строка $key не является допустимым значением.

setMultiple()source public

setMultiple( iterable $values , null|integer|DateInterval $ttl = null )

Сохраняет набор пар ключ => значение в кэше с необязательным TTL.

Параметры

итерируемый объект $values

Список пар ключ => значение для многократной операции записи.

null|целое число|DateInterval $ttl необязательно null

Необязательно. Значение TTL этого элемента. Если значение не отправлено, и драйвер поддерживает TTL, библиотека может установить для него значение по умолчанию или позволить драйверу позаботиться об этом.

Возвращает

boolean
Истина при успехе и ложь при неудаче.

Возможные исключения

Cake\Cache\InvalidArgumentException

Если $values не является массивом или Traversable, или если любое из значений $values не является допустимым значением.