Класс RedisEngine

__destructsource public

__destruct( )

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

_connectsource protected

_connect( )

Подключается к серверу Redis

Возвращает

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

addsource public

add( string $key , mixed $value )

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

Параметры

string $key

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

mixed $value

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

Возвращает

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

Ссылка

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

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

Cake\Cache\CacheEngine::add()

clearsource public

clear( boolean $check )

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

Параметры

boolean $check

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

Возвращает

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

clearGroupsource public

clearGroup( string $group )

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

Параметры

string $group

имя группы, которая должна быть очищена

Возвращает

boolean
Успех

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

Cake\Cache\CacheEngine::clearGroup()

decrementsource public

decrement( string $key , integer $offset 1 )

Уменьшает значение целочисленного ключа в кеше

Параметры

string $key

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

integer $offset optional 1

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

Возвращает

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

deletesource public

delete( string $key )

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

Параметры

string $key

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

Возвращает

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

groupssource public

groups( )

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

Возвращает

array
Массив

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

Cake\Cache\CacheEngine::groups()

incrementsource public

increment( string $key , integer $offset 1 )

Увеличивает значение целочисленного ключа в кеше

Параметры

string $key

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

integer $offset optional 1

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

Возвращает

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

initsource public

init( array $config [] )

Инициализировать движок кеширования

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

Параметры

array $config optional []

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

Возвращает

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

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

Cake\Cache\CacheEngine::init()

readsource public

read( string $key )

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

Параметры

string $key

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

Возвращает

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

writesource public

write( string $key , mixed $value )

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

Параметры

string $key

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

mixed $value

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

Возвращает

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

_keysource protected

_key( string $key )

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

Параметры

string $key

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

Возвращает

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

Выбрасывает

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

deleteManysource public

deleteMany( array $keys )

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

Параметры

array $keys

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

Возвращает

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

gcsource public

gc( integer|null $expires null )

Сбор мусора

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

Параметры

integer|null $expires optional null

[необязательно] Маркер времени истечения срока действия, делая все данные до него недействительными.

keysource public

key( string $key )

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

Параметры

string $key

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

Возвращает

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

readManysource public

readMany( array $keys )

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

Параметры

array $keys

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

Возвращает

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

writeManysource public

writeMany( array $data )

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

Параметры

массив $data

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

Возвращает

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

_configDeletesource protected

_configDelete( string $key )

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

Параметры

строка $key

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

Выбрасывает

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

_configReadsource protected

_configRead( string|null $key )

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

Параметры

строка|null $key

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

Возвращает

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

_configWritesource protected

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

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

Параметры

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

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

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

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

булево|строка $merge необязательный false

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

Выбрасывает

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

configsource 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

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

булево $merge необязательный true

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

Возвращает

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

Выбрасывает

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

configShallowsource 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

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

Возвращает

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

null

[]

false