Класс RedisEngine

__destruct()source public

__destruct( )

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

_connect()source protected

_connect( )

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

Возвращает

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

add()source public

add( string $key , mixed $value )

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

Параметры

строка $key

Идентификатор данных.

смешанный $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 )

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

Параметры

строка $group

имя группы для очистки

Возвращает

boolean
успех

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

Cake\Cache\CacheEngine::clearGroup()

decrement()source public

decrement( string $key , integer $offset = 1 )

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

Параметры

строка $key

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

целое число $offset необязательно 1

На сколько уменьшить

Возвращает

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

delete()source public

delete( string $key )

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

Параметры

строка $key

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

Возвращает

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

groups()source public

groups( )

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

Возвращает

массив

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

Cake\Cache\CacheEngine::groups()

increment()source public

increment( string $key , integer $offset = 1 )

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

Параметры

строка $key

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

целое число $offset необязательно 1

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

Возвращает

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

init()source public

init( array $config = [] )

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

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

Параметры

массив $config необязательно []

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

Возвращает

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

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

Cake\Cache\CacheEngine::init()

read()source public

read( string $key )

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

Параметры

строка $key

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

Возвращает

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

write()source public

write( string $key , mixed $value )

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

Параметры

строка $key

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

смешанный $value

Данные для кэширования

Возвращает

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

_key()source protected

_key( string $key )

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

Параметры

строка $key

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

Возвращает

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

Вызывает исключение

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

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

Возвращает

логическое значение|строка
строка ключа или ложь

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 в случае неудачи

_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 deprecated

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