Класс RedisEngine
Двигатель хранения Redis для кеширования.
- CacheEngine
-
RedisEngine
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение Cake/Cache/Engine/RedisEngine.php
Подробное описание методов
_connectsource protected
_connect( )
Подключается к серверу Redis
Возвращает
booleanИстина, если сервер Redis подключен
clearsource public
clear( boolean $check )
Удаляет все ключи из кеша
Параметры
- boolean
$check - Указывает, следует ли проверять ключи истечения срока действия. Если истинно, никакие ключи не будут удалены, так как кеш будет полагаться на TTL Redis.
Возвращает
booleanИстина, если кеш был успешно очищен, иначе ложь
clearGroupsource public
clearGroup( string $group )
Увеличивает значение группы, чтобы смоделировать удаление всех ключей в группе. Старые значения останутся в хранилище до тех пор, пока они не истекут.
Параметры
- string
$group - Имя группы для очистки.
Возвращает
booleanУспех
Переопределяет
CacheEngine::clearGroup() decrementsource public
decrement( string $key , integer $offset 1 )
Уменьшает значение целочисленного кешированного ключа
Параметры
- string
$key - Идентификатор данных
- integer
$offsetнеобязательно 1 - На сколько уменьшить
Возвращает
NewУменьшенное значение, иначе ложь
Выбрасывает
CacheExceptionпри попытке уменьшить с compress = true
deletesource public
delete( string $key )
Удаляет ключ из кеша
Параметры
- string
$key - Идентификатор данных
Возвращает
booleanИстина, если значение было успешно удалено, ложь, если оно не существовало или не могло быть удалено
groupssource public
groups( )
Возвращает group value для каждой из настроенных групп. Если начальное значение группы не найдено, то группа инициализируется соответствующим образом.
Возвращает
arrayМассив
Переопределяет
CacheEngine::groups() incrementsource public
increment( string $key , integer $offset 1 )
Увеличивает значение целочисленного кешированного ключа
Параметры
- string
$key - Идентификатор данных
- integer
$offsetнеобязательно 1 - На сколько увеличить
Возвращает
NewУвеличенное значение, иначе ложь
Выбрасывает
CacheExceptionпри попытке увеличить с compress = true
initsource public
init( array $settings array() )
Инициализировать движок кеширования
Вызывается автоматически передним фронтом кеширования. Для повторной инициализации настроек вызовите Cache::engine('EngineName', [необязательно] settings = array());
Параметры
- array
$settingsнеобязательно array() - массив настроек для движка
Возвращает
booleanИстина, если движок был успешно инициализирован, иначе ложь
Переопределяет
CacheEngine::init() readsource public
read( string $key )
Считывает ключ из кеша
Параметры
- string
$key - Идентификатор данных
Возвращает
mixedКешированные данные или ложь, если данные не существуют, истекли или произошла ошибка при их извлечении
writesource public
write( string $key , mixed $value , integer $duration )
Записывает данные для ключа в кеш.
Параметры
- string
$key - Идентификатор данных
- mixed
$value - Данные для кеширования
- integer
$duration - Время кеширования данных в секундах
Возвращает
booleanИстина, если данные были успешно сохранены в кеше, ложь в случае неудачи
Наследуемые методы из CacheEngine
gcsource public
gc( integer $expires null )
Сбор мусора
Постоянно удаляет все устаревшие и удаленные данные
Параметры
- integer
$expiresнеобязательно null - [необязательно] Маркер времени истечения, делающий все данные, предшествующие ему, недействительными.
keysource public
key( string $key )
Создаёт безопасный ключ для использования с движками хранения кеша.
Параметры
- string
$key - переданный ключ
Возвращает
mixedстрока $key или ложь
Краткое описание свойств
Наследуемые свойства из CacheEngine
$_groupPrefixsource
protected string
Содержит скомпилированную строку со всеми префиксами групп, которые будут добавлены к каждому ключу в этом движке кеширования
null
© 2005–2016 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.
http://api.cakephp.org/2.7/class-RedisEngine.html