Spec-Zone.ru › CakePHP 3.5

Класс RedisEngine

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

Cake\Cache\CacheEngine использует Cake\Core\InstanceConfigTrait
Extended by Cake\Cache\Engine\RedisEngine
Пространство имён: Cake\Cache\Engine
Расположение: Cache/Engine/RedisEngine.php

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

  • $_Redis protected
    Redis
    Обёртка Redis.
  • $_defaultConfig protected
    array
    Конфигурация по умолчанию, если не переопределена конфигурацией во время выполнения.

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

  • _groupPrefix _config, _configInitialized

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

  • __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
    Запись данных для ключа в кеш.

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

__destruct()source public 

__destruct( )

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

_connect()source protected 

_connect( )

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

Возвращает

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

add()source public 

add( string $key , mixed $value )

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

Параметры

string $key
Идентификатор данных.
mixed $value
Данные для кеширования.

Возвращает

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

Ссылка

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

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

Cake\Cache\CacheEngine::add()

clear()source public 

clear( boolean $check )

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

Параметры

boolean $check
Если true, проверяется время истечения срока действия, иначе удаляются все ключи.

Возвращает

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

clearGroup()source public 

clearGroup( string $group )

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

Параметры

string $group
Название группы для очистки

Возвращает

boolean
Успех

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

Cake\Cache\CacheEngine::clearGroup()

decrement()source public 

decrement( string $key , integer $offset 1 )

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

Параметры

string $key
Идентификатор данных
integer $offset optional 1
На сколько уменьшить

Возвращает

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

delete()source public 

delete( string $key )

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

Параметры

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

Возвращает

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

groups()source public 

groups( )

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

Возвращает

array

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

Cake\Cache\CacheEngine::groups()

increment()source public 

increment( string $key , integer $offset 1 )

Увеличивает значение целочисленного ключа в кеше и обновляет время истечения срока действия

Параметры

string $key
Идентификатор данных
integer $offset optional 1
На сколько увеличить

Возвращает

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

init()source public 

init( array $config [] )

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

Вызывается автоматически фронтендом кеша

Параметры

array $config optional []
массив настроек для движка

Возвращает

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

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

Cake\Cache\CacheEngine::init()

read()source public 

read( string $key )

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

Параметры

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

Возвращает

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

write()source public 

write( string $key , mixed $value )

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

Параметры

string $key
Идентификатор данных
mixed $value
Данные для кеширования

Возвращает

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

Методы, унаследованные от Cake\Cache\CacheEngine

_key()source protected 

_key( string $key )

Генерирует безопасный ключ, учитывая конфигурированный префикс ключа

Параметры

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

Возвращает

mixed
строка $key или false

Исключения

InvalidArgumentException
Если значение ключа пустое

deleteMany()source public 

deleteMany( array $keys )

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

Параметры

массив $keys
Массив идентификаторов данных

Возвращает

массив

Для каждого предоставленного ключа кэша (переданного в качестве ключа массива) true, если значение было успешно удалено, false, если его не существовало или не удалось удалить


gc()source public 

gc( integer|null $expires null )

Сбор мусора

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

Параметры

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

key()source public 

key( string $key )

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

Параметры

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

Возвращает

boolean|string
строка ключа или false

readMany()source public 

readMany( array $keys )

Чтение нескольких ключей из кэша

Параметры

массив $keys
Массив идентификаторов данных

Возвращает

массив

Для каждого ключа кэша (указанного как ключ массива) сопоставленные данные кэша или false, если данные не существуют, истекли или произошла ошибка при их извлечении


writeMany()source public 

writeMany( array $data )

Запись данных для многих ключей в кэш

Параметры

массив $data
Массив данных, которые нужно сохранить в кэше

Возвращает

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

Методы, используемые из Cake\Core\InstanceConfigTrait

_configDelete()source protected 

_configDelete( string $key )

Удаляет один ключ конфигурации.

Параметры

строка $key
Ключ для удаления.

Исключения

Cake\Core\Exception\Exception
если пытаетесь перезаписать существующую конфигурацию

_configRead()source protected 

_configRead( string|null $key )

Считывает ключ конфигурации.

Параметры

строка|null $key
Ключ для чтения.

Возвращает

mixed

_configWrite()source protected 

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Записывает ключ конфигурации.

Параметры

строка|массив $key
Ключ для записи.
mixed $value
Значение для записи.
boolean|строка $merge необязательно false

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Исключения

Cake\Core\Exception\Exception
если пытаетесь перезаписать существующую конфигурацию

config()source public 

config( string|array|null $key null , mixed|null $value null , boolean $merge true )

Получение/Установка конфигурации.

Использование

Чтение всей конфигурации:

$this->config();

Чтение определенного значения:

$this->config('key');

Чтение вложенного значения:

$this->config('some.nested.key');

Установка определенного значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких параметров конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Устарело

3.4.0 используйте setConfig()/getConfig() вместо этого.

Параметры

строка|массив|null $key необязательно null
Ключ для получения/установки или весь массив конфигураций.
mixed|null $value необязательно null
Значение для установки.
boolean $merge необязательно true
Выполнять рекурсивное слияние или перезапись существующей конфигурации, по умолчанию true.

Возвращает

mixed
Значение конфигурации, которое считывается, или сам объект при операциях записи.

Исключения

Cake\Core\Exception\Exception
При попытке установить недопустимый ключ.

configShallow()source public 

configShallow( string|array $key , mixed|null $value null )

Объединяет предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), которая выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

Установка определенного значения:

$this->configShallow('key', $value);

Установка вложенного значения:

$this->configShallow('some.nested.key', $value);

Обновление нескольких параметров конфигурации одновременно:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Параметры

строка|массив $key
Ключ для установки или весь массив конфигураций.
mixed|null $value необязательно null
Значение для установки.

Возвращает


$this

getConfig()source public 

getConfig( string|null $key null , mixed $default null )

Возвращает конфигурацию.

Использование

Чтение всей конфигурации:

$this->getConfig();

Чтение определенного значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

строка|null $key необязательно null
Ключ для получения или null для всей конфигурации.
mixed $default необязательно null
Возвращаемое значение, когда ключ не существует.

Возвращает

mixed
Значение конфигурации, которое считывается.

setConfig()source public 

setConfig( string|array $key , mixed|null $value null , boolean $merge true )

Устанавливает конфигурацию.

Использование

Установка определенного значения:

$this->setConfig('key', $value);

Установка вложенного значения:

$this->setConfig('some.nested.key', $value);

Обновление нескольких параметров конфигурации одновременно:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Параметры

строка|массив $key
Ключ для установки или весь массив конфигураций.
mixed|null $value необязательно null
Значение для установки.
boolean $merge необязательно true
Выполнять рекурсивное слияние или перезапись существующей конфигурации, по умолчанию true.

Возвращает


$this

Исключения

Cake\Core\Exception\Exception
При попытке установить недопустимый ключ.

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

$_Redissource

protected Redis

Обёртка над Redis.

END_OF_DOCUMENT_MARKER

$_defaultConfigsource

protected array

Значение конфигурации по умолчанию, если не переопределено в конфигурации выполнения

  • database номер базы данных для подключения.
  • duration Указывает, как долго элементы в этой конфигурации кэша сохраняются.
  • groups Список групп или «меток», связанных с каждым ключом, хранящимся в этой конфигурации. Полезно для удаления целой группы из кэша.
  • password Пароль сервера Redis.
  • persistent Подключение к серверу Redis с постоянным соединением
  • port номер порта сервера Redis.
  • prefix Префикс, добавляемый ко всем записям. Полезно, когда вам нужно использовать один и тот же пространство имен ключей с другой конфигурацией кэша или другим приложением.
  • probability Вероятность запуска очистки кэша gc. Установка в 0 отключит автоматический вызов cache::gc.
  • server URL или IP-адрес хоста сервера Redis.
  • timeout таймаут в секундах (вещественное число).
  • unix_socket Путь к файлу unix-сокет (по умолчанию: false)
[
    'database' => 0,
    'duration' => 3600,
    'groups' => [],
    'password' => false,
    'persistent' => true,
    'port' => 6379,
    'prefix' => 'cake_',
    'probability' => 100,
    'host' => null,
    'server' => '127.0.0.1',
    'timeout' => 0,
    'unix_socket' => false,
]

© 2005–2018 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/3.5/class-Cake.Cache.Engine.RedisEngine.html

Spec-Zone.ru

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