Spec-Zone.ru › CakePHP 2.7

Класс RedisEngine

Двигатель хранения Redis для кеширования.

CacheEngine
Extended by RedisEngine
Пакет: Cake\Cache\Engine
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение Cake/Cache/Engine/RedisEngine.php

Подробное описание методов

__destructsource public

__destruct( )

Отключается от сервера redis

_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 или ложь

settingssource public

settings( )

Настройки движка кеширования

Возвращает

array
настройки

Краткое описание свойств

$_Redissource

protected Redis

Обёртка Redis.

null

$settingssource

public array

Настройки

  • server = строка URL или IP-адрес хоста Redis - database = целочисленное число базы данных для подключения - port = целочисленное число порта сервера Redis (по умолчанию: 6379) - timeout = дробное число таймаута в секундах (по умолчанию: 0) - persistent = логическое значение Подключается к серверу Redis с постоянным подключением (по умолчанию: true) - unix_socket = путь к файлу unix-соккета (по умолчанию: ложь)
array()

Наследуемые свойства из 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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API