Класс RedisEngine
Двигатель Redis для кэша.
- CacheEngine
-
RedisEngine
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Cache/Engine/RedisEngine.php
Краткое описание свойств
Унаследованные свойства
Краткое описание методов
- __destruct() publicОтключение от сервера Redis
- _connect() protectedПодключение к серверу Redis
- add() public
Запись данных для ключа в кэш, если он ещё не существует. Если ключ уже существует, попытка завершается ошибкой и возвращает false.
- clear() publicУдаление всех ключей из кэша
- clearGroup() public
Увеличивает значение группы, чтобы смоделировать удаление всех ключей в группе. Старые значения останутся в хранилище до истечения срока их действия.
- decrement() publicУменьшает значение целочисленного кэшированного ключа
- delete() publicУдаление ключа из кэша
- groups() public
Возвращает
group valueдля каждой из настроенных групп. Если начальное значение группы не найдено, оно инициализируется соответствующим образом. - increment() publicУвеличивает значение целочисленного кэшированного ключа
- init() publicИнициализация двигателя кэша
- read() publicЧтение ключа из кэша
- write() publicЗапись данных для ключа в кэш.
Подробное описание методов
_connect()source protected
_connect( )
Подключение к серверу Redis
Возвращает
booleanTrue, если сервер Redis подключен
add()source public
add( string $key , mixed $value , integer $duration )
Запись данных для ключа в кэш, если он ещё не существует. Если ключ уже существует, попытка завершается ошибкой и возвращает false.
Параметры
- строка
$key - Идентификатор данных.
- смешанное
$value - Данные для кэширования.
- целое число
$duration - Срок кэширования данных в секундах.
Возвращает
booleanTrue, если данные успешно кэшированы, false в случае ошибки.
Ссылка
https://github.com/phpredis/phpredis#setnxПереопределяет
CacheEngine::add() clear()source public
clear( boolean $check )
Удаление всех ключей из кэша
Параметры
- boolean
$check Указывает, следует ли проверять ключи истечения срока действия. Если true, ключи не будут удалены, так как кэш будет полагаться на TTL Redis.
Возвращает
booleanTrue, если кэш успешно очищен, false в противном случае
clearGroup()source public
clearGroup( string $group )
Увеличивает значение группы, чтобы смоделировать удаление всех ключей в группе. Старые значения останутся в хранилище до истечения срока их действия.
Параметры
- строка
$group - Имя группы для очистки.
Возвращает
booleanуспех
Переопределяет
CacheEngine::clearGroup() decrement()source public
decrement( string $key , integer $offset 1 )
Уменьшает значение целочисленного кэшированного ключа
Параметры
- строка
$key - Идентификатор данных
- целое число
$offsetoptional 1 - На сколько уменьшить
Возвращает
Новоеуменьшенное значение, false в противном случае
Использует
CacheExceptionпри попытке уменьшить с compress = true
delete()source public
delete( string $key )
Удаление ключа из кэша
Параметры
- строка
$key - Идентификатор данных
Возвращает
booleanTrue, если значение было успешно удалено, false, если его не существовало или не удалось удалить
groups()source public
groups( )
Возвращает group value для каждой из настроенных групп. Если начальное значение группы не найдено, оно инициализируется соответствующим образом.
Возвращает
массивПереопределяет
CacheEngine::groups() increment()source public
increment( string $key , integer $offset 1 )
Увеличивает значение целочисленного кэшированного ключа
Параметры
- строка
$key - Идентификатор данных
- целое число
$offsetoptional 1 - На сколько увеличить
Возвращает
Новоеувеличенное значение, false в противном случае
Использует
CacheExceptionпри попытке увеличить с compress = true
init()source public
init( array $settings array() )
Инициализация двигателя кэша
Вызывается автоматически фронтендом кэша. Для повторной инициализации настроек вызовите Cache::engine('EngineName', [optional] settings = array());
Параметры
- массив
$settingsoptional array() - массив настроек для двигателя
Возвращает
booleanTrue, если движок успешно инициализирован, false в противном случае
Переопределяет
CacheEngine::init() read()source public
read( string $key )
Чтение ключа из кэша
Параметры
- строка
$key - Идентификатор данных
Возвращает
смешанноеКэшированные данные или false, если данные не существуют, истекли или произошла ошибка при их извлечении
write()source public
write( string $key , mixed $value , integer $duration )
Запись данных для ключа в кэш.
Параметры
- строка
$key - Идентификатор данных
- смешанное
$value - Данные для кэширования
- целое число
$duration - Срок кэширования данных в секундах
Возвращает
booleanTrue, если данные успешно кэшированы, false в случае ошибки
Унаследованные методы из CacheEngine
gc()source public
gc( integer $expires null )
Сбор мусора
Постоянно удаляет все устаревшие и удалённые данные
Параметры
- integer
$expiresнеобязательный null - [необязательно] Отметка времени истечения срока действия, аннулирующая все данные до неё.
key()source public
key( string $key )
Генерирует безопасный ключ для использования с хранилищами кэша.
Параметры
- string
$key - переданный ключ
Возвращаемое значение
mixedstring $key или false
Подробное описание свойств
$settingssource
public array
Настройки
- server = строка URL или IP хоста сервера Redis
- database = целое число номера базы данных для подключения
- port = целое число номер порта сервера Redis (по умолчанию: 6379)
- timeout = число таймаут в секундах (по умолчанию: 0)
- persistent = логическое значение Подключается к серверу Redis с постоянным подключением (по умолчанию: true)
- unix_socket = путь к файлу unix-соккета (по умолчанию: false)
array()
© 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.
https://api.cakephp.org/2.9/class-RedisEngine.html