Spec-Zone.ru › CakePHP 2.10

Класс RedisEngine

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

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

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

  • $_Redis protected
    Redis
    Обертка над Redis.
  • $settings public
    array
    Настройки

Унаследованные свойства

  • _groupPrefix

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

  • __destruct() public
    Отключение от сервера redis
  • _connect() protected
    Подключение к серверу Redis
  • add() public

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

  • clear() public
    Удаление всех ключей из кэша
  • clearGroup() public

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

  • decrement() public
    Уменьшение значения целочисленного кэшированного ключа
  • delete() public
    Удаление ключа из кэша
  • groups() public

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

  • increment() public
    Увеличение значения целочисленного кэшированного ключа
  • init() public
    Инициализация кэша
  • read() public
    Чтение ключа из кэша
  • write() public
    Запись данных для ключа в кэш.

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

__destruct()source public

__destruct( )

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

_connect()source protected

_connect( )

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

Возвращает

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

add()source public

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

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

Параметры

строка $key
Идентификатор данных.
смешанные $value
Данные для кэширования.
целое число $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 )

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

Параметры

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

Возвращает

boolean
Успешно

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

CacheEngine::clearGroup()

decrement()source public

decrement( string $key , integer $offset 1 )

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

Параметры

строка $key
Идентификатор данных
целое число $offset необязательно 1
На сколько уменьшить

Возвращает

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

Выбрасывает

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

delete()source public

delete( string $key )

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

Параметры

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

Возвращает

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

groups()source public

groups( )

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

Возвращает

массив

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

CacheEngine::groups()

increment()source public

increment( string $key , integer $offset 1 )

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

Параметры

строка $key
Идентификатор данных
целое число $offset необязательно 1
На сколько увеличить

Возвращает

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

Выбрасывает

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

init()source public

init( array $settings array() )

Инициализация кэша

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

Параметры

массив $settings необязательно array()
массив настроек для движка

Возвращает

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

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

CacheEngine::init()

read()source public

read( string $key )

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

Параметры

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

Возвращает

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

write()source public

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

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

Параметры

строка $key
Идентификатор данных
смешанные $value
Данные для кэширования
целое число $duration
Время кэширования данных в секундах

Возвращает

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

Унаследованные методы от CacheEngine

gc()source public

gc( integer $expires null )

Сбор мусора

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

Параметры

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

key()source public

key( string $key )

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

Параметры

строка $key
переданный ключ

Возвращаемое значение

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

settings()source public

settings( )

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

Возвращаемое значение

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

Подробности свойств

$_Redissource

protected Redis

Обёртка Redis.

null

$settingssource

public массив

Настройки

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

© 2005–2017 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.10/class-RedisEngine.html

Spec-Zone.ru

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