Класс RedisEngine

__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 необязательно 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 необязательно 1

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

Возвращает

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

init()source public

init( array $config [] )

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

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

Параметры

array $config необязательно []

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

Возвращает

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 в случае ошибки

_key()source protected

_key( string $key )

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

Параметры

string $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|строка
ключ строки или false

readMany()source public

readMany( array $keys )

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

Параметры

массив $keys

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

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

массив

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

writeMany()source public

writeMany( array $data )

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

Параметры

массив $data

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

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

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

_configDelete()source protected

_configDelete( string $key )

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

Параметры

строка $key

Ключ для удаления.

Исключения

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

_configRead()source protected

_configRead( string|null $key )

Чтение конфигурационной переменной

Параметры

строка|null $key

Ключ для чтения.

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

смешанный тип

_configWrite()source protected

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

Запись конфигурационной переменной

Параметры

строка|массив $key

Ключ для записи.

смешанный тип $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']);

Параметры

строка|массив|null $key необязательно null

Ключ для получения/установки или массив конфигураций.

смешанный тип|null $value необязательно null

Значение для установки.

boolean $merge необязательно true

Производить рекурсивное слияние или перезапись существующей конфигурации, по умолчанию true.

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

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

Исключения

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

configShallow()source public

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

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

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

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

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

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

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

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

Параметры

строка|массив $key

Ключ для установки или массив конфигураций.

смешанный тип|null $value необязательно null

Значение для установки.

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

$this Сам объект.

null

[
    '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,
]