Класс 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 )

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

Параметры

логическое $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( )

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

Возвращает

массив

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

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

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

Возвращает

boolean|строка
ключ строки или ложь

readMany()source public

readMany( array $keys )

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

Параметры

массив $keys

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

Возвращает

массив

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

warning()source protected

warning( string $message )

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

Параметры

строка $message

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

writeMany()source public

writeMany( array $data )

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

Параметры

массив $data

Массив данных для хранения в кэше

Возвращает

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

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

boolean $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

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

Возвращает

смешанный
Данные конфигурации по указанному ключу или 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

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

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