Класс RedisEngine

__destruct()source public

__destruct( )

Отключение от сервера redis.

_connect()source protected

_connect( )

Подключение к серверу Redis.

Возвращает

boolean
True, если сервер Redis подключен, иначе false.

add()source public

add( string $key , mixed $value , integer $duration )

Запись данных для ключа в кеш, если он еще не существует. Если ключ уже существует, операция завершается ошибкой и возвращает false.

Параметры

string $key

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

mixed $value

Данные для кеширования.

integer $duration

Срок кеширования данных в секундах.

Возвращает

boolean
True, если данные успешно кешированы, false в случае ошибки.

Ссылка

https://github.com/phpredis/phpredis#setnx

Переопределяет

CacheEngine::add()

clear()source public

clear( boolean $check )

Удаление всех ключей из кеша

Параметры

boolean $check

Определяет, следует ли проверять ключи истечения срока действия. Если true, ключи не будут удалены, так как кеширование будет полагаться на TTL Redis.

Возвращает

boolean
True, если кеш успешно очищен, иначе false.

clearGroup()source public

clearGroup( string $group )

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

Параметры

string $group

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

Возвращает

boolean
УСПЕХ

Переопределяет

CacheEngine::clearGroup()

decrement()source public

decrement( string $key , integer $offset 1 )

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

Параметры

string $key

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

integer $offset необязательно 1

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

Возвращает

Новое
уменьшенное значение, false в противном случае

Исключение

CacheException
при попытке уменьшить значение с compress = true

delete()source public

delete( string $key )

Удаление ключа из кеша

Параметры

string $key

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

Возвращает

boolean
True, если значение было успешно удалено, false, если значения не существовало или не удалось его удалить

groups()source public

groups( )

Возвращает значения group value для каждой из настроенных групп. Если начальное значение группы не найдено, то оно инициализируется соответствующим образом.

Возвращает

array

Переопределяет

CacheEngine::groups()

increment()source public

increment( string $key , integer $offset 1 )

Увеличение значения целочисленного кешированного ключа

Параметры

string $key

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

integer $offset необязательно 1

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

Возвращает

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

Исключение

CacheException
при попытке увеличить значение с compress = true

init()source public

init( array $settings array() )

Инициализация кеш-движка

Вызывается автоматически кеш-фронтом. Для повторной инициализации настроек вызовите Cache::engine('EngineName', [необязательные] settings = array());

Параметры

array $settings необязательно array()

массив настроек для движка

Возвращает

boolean
True, если движок успешно инициализирован, false в противном случае

Переопределяет

CacheEngine::init()

read()source public

read( string $key )

Чтение ключа из кеша

Параметры

string $key

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

Возвращает

mixed
Кешированные данные или false, если данных нет, срок действия истек или при возникновении ошибки при получении

write()source public

write( string $key , mixed $value , integer $duration )

Запись данных для ключа в кеш.

Параметры

string $key

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

mixed $value

Данные для кеширования

integer $duration

Срок кеширования данных в секундах

Возвращает

boolean
True, если данные были успешно кешированы, false в противном случае

gc()source public

gc( integer $expires null )

Сбор мусора

Постоянно удаляет все истекшие и удалённые данные

Параметры

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

[необязательно] Отметка времени истечения срока действия, делающая все данные, предшествующие ей, недействительными.

key()source public

key( string $key )

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

Параметры

строка $key

переданный ключ

Возвращает

смешанный тип
строка $key или false

settings()source public

settings( )

Настройки кэша

Возвращает

массив
настройки

null

array()