Класс SimpleCacheEngine

__construct()source public

__construct( Cake\Cache\CacheEngine $innerEngine )

Конструктор

Параметры

Cake\Cache\CacheEngine $innerEngine

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

add()source public

add( string $key , mixed $value )

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

Параметры

строка $key

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

смешанный $value

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

Возвращает

boolean

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

Реализация

Cake\Cache\CacheEngineInterface::add()

clear()source public

clear( )

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

Возвращает

boolean
Истина при успехе, ложь при ошибке.

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|целое число
Новое уменьшенное значение, ложь в противном случае

Реализация

Cake\Cache\CacheEngineInterface::decrement()

delete()source public

delete( string $key )

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

Параметры

строка $key

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

Возвращает

boolean
Истина, если элемент успешно удален. Ложь, если произошла ошибка.

Выбрасывает

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

deleteMultiple()source public

deleteMultiple( iterable $keys )

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

Параметры

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

Список строк-ключей для удаления.

Возвращает

boolean
Истина, если элементы успешно удалены. Ложь, если произошла ошибка.

Выбрасывает

Cake\Cache\InvalidArgumentException

Если $keys не является массивом или Iterable, или если какой-либо из $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 не является массивом или Iterable, или если какой-либо из $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|integer
Новое увеличенное значение, иначе false

Реализация

Cake\Cache\CacheEngineInterface::increment()

set()source public

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

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

Параметры

строка $key

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

смешанное $value

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

null|целое число|DateInterval $ttl опционально null

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

Возвращает

boolean
True при успехе и false при неудаче.

Выбрасывает

Cake\Cache\InvalidArgumentException
ДОЛЖНО быть выброшено, если строка $key не является допустимым значением.

setMultiple()source public

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

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

Параметры

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

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

null|целое число|DateInterval $ttl опционально null

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

Возвращает

boolean
True при успехе и false при неудаче.

Выбрасывает

Cake\Cache\InvalidArgumentException

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