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

_key()source protected

_key( string $key )

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

Параметры

строка $key

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

Возвращает

смешанный
строка $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

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

Возвращает

булево значение|строка
строка ключа или false

readMany()source public

readMany( array $keys )

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

Параметры

массив $keys

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

Возвращает

массив

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

warning()source protected

warning( string $message )

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

Параметры

строка $message

Сообщение о предупреждении.

writeMany()source public

writeMany( array $data )

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

Параметры

массив $data

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

Возвращает

массив
значений true/false для каждого предоставленного ключа, 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

Значение для записи.

булево значение|строка $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

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

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

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

булево значение $merge необязательно true

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

Возвращает

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

Исключения

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

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

смешанный|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 для всей конфигурации.

смешанный $default необязательно null

Возвращаемое значение, если ключ не существует.

Возвращает

смешанный
Значение конфигурации, которое читается.

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

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

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

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

булево значение $merge необязательно true

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

Возвращает

$this

Исключения

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

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