PhpRedisConnection
класс PhpRedisConnection расширяет Connection реализует Connection mixin Redis (View source)
Черты
| PacksPhpRedisValues | |
| Macroable |
Свойства
| static protected array | $macros | Зарегистрированные строковые макросы. | из Macroable |
| protected Redis | $client | Клиент Redis. | из Connection |
| protected string|null | $name | Имя соединения Redis. | из Connection |
| protected Dispatcher | $events | Экземпляр диспетчера событий. | из Connection |
| protected bool|null | $supportsPacking | Указывает, поддерживает ли Redis упаковку. | из PacksPhpRedisValues |
| protected bool|null | $supportsLzf | Указывает, поддерживает ли Redis сжатие LZF. | из PacksPhpRedisValues |
| protected bool|null | $supportsZstd | Указывает, поддерживает ли Redis сжатие Zstd. | из PacksPhpRedisValues |
| protected callable | $connector | Обратный вызов для создания соединения. | |
| protected array | $config | Массив конфигурации соединения. |
Методы
| static void | macro(string $name, object|callable $macro)
Зарегистрировать пользовательский макрос. | from Macroable |
| static void | mixin(object $mixin, bool $replace = true)
Включить другой объект в класс. | from Macroable |
| static bool | hasMacro(string $name)
Проверяет, зарегистрирован ли макрос. | from Macroable |
| static void | flushMacros()
Очистить существующие макросы. | from Macroable |
| static mixed | __callStatic(string $method, array $parameters)
Динамически обрабатывает вызовы класса. | from Macroable |
| mixed | __call(string $method, array $parameters)
Передать другие вызовы методов базовому клиенту. | |
| void | createSubscription(array|string $channels, Closure $callback, string $method = 'subscribe')
Подписаться на набор заданных каналов для сообщений. | |
| ConcurrencyLimiterBuilder | funnel(string $name)
Канал для колбэка с максимальным числом одновременных выполнений. | from Connection |
| DurationLimiterBuilder | throttle(string $name)
Регулирование колбэка для максимального количества выполнений за заданный период времени. | from Connection |
| mixed | client()
Получить базовый клиент Redis. | from Connection |
| void | subscribe(array|string $channels, Closure $callback)
Подписаться на набор заданных каналов для сообщений. | |
| void | psubscribe(array|string $channels, Closure $callback)
Подписаться на набор заданных каналов с подстановочными знаками. | |
| mixed | command(string $method, array $parameters = [])
Выполнить команду для базы данных Redis. | |
| void | event(mixed $event)
Отправить заданное событие, если возможно. | from Connection |
| void | listen(Closure $callback)
Зарегистрировать прослушиватель команд Redis с соединением. | from Connection |
| string|null | getName()
Получить имя соединения. | from Connection |
| $this | setName(string $name)
Установить имя соединения. | from Connection |
| Dispatcher | getEventDispatcher()
Получить диспетчер событий, используемый соединением. | from Connection |
| void | setEventDispatcher(Dispatcher $events)
Установить экземпляр диспетчера событий для соединения. | from Connection |
| void | unsetEventDispatcher()
Сбросить экземпляр диспетчера событий для соединения. | from Connection |
| array | pack(array $values)
Подготавливает заданные значения для использования с командой | from PacksPhpRedisValues |
| bool | compressed()
Определяет, включено ли сжатие. | from PacksPhpRedisValues |
| bool | lzfCompressed()
Определяет, включено ли сжатие LZF. | from PacksPhpRedisValues |
| bool | zstdCompressed()
Определяет, включено ли сжатие ZSTD. | from PacksPhpRedisValues |
| bool | lz4Compressed()
Определяет, включено ли сжатие LZ4. | from PacksPhpRedisValues |
| bool | supportsPacking()
Определяет, поддерживает ли текущая версия расширения PhpRedis упаковку. | from PacksPhpRedisValues |
| bool | supportsLzf()
Определяет, поддерживает ли текущая версия расширения PhpRedis сжатие LZF. | from PacksPhpRedisValues |
| bool | supportsZstd()
Определяет, поддерживает ли текущая версия расширения PhpRedis сжатие Zstd. | from PacksPhpRedisValues |
| bool | phpRedisVersionAtLeast(string $version)
Определяет, является ли версия расширения PhpRedis не менее заданной версии. | from PacksPhpRedisValues |
| void | __construct(Redis $client, callable $connector = null, array $config = [])
Создать новое соединение PhpRedis. | |
| string|null | get(string $key)
Возвращает значение данного ключа. | |
| array | mget(array $keys)
Получить значения всех заданных ключей. |
| bool | set(string $key, mixed $value, string|null $expireResolution = null, int|null $expireTTL = null, string|null $flag = null)
Установить строковое значение в аргументе в качестве значения ключа. | |
| int | setnx(string $key, string $value)
Установить данный ключ, если он не существует. | |
| array | hmget(string $key, mixed ...$dictionary)
Получить значение заданных хеш-полей. | |
| int | hmset(string $key, mixed ...$dictionary)
Установить заданные хеш-поля своим соответствующим значениям. | |
| int | hsetnx(string $hash, string $key, string $value)
Установить заданное поле хеша, если оно не существует. | |
| int|false | lrem(string $key, int $count, mixed $value)
Удаляет первые count вхождений элемента value из списка. | |
| array|null | blpop(mixed ...$arguments)
Удаляет и возвращает первый элемент списка, хранящегося по ключу. | |
| array|null | brpop(mixed ...$arguments)
Удаляет и возвращает последний элемент списка, хранящегося по ключу. | |
| mixed|false | spop(string $key, int|null $count = 1)
Удаляет и возвращает случайный элемент из значения множества по ключу. | |
| int | zadd(string $key, mixed ...$dictionary)
Добавить один или несколько элементов в отсортированное множество или обновить его оценку, если он уже существует. | |
| array | zrangebyscore(string $key, mixed $min, mixed $max, array $options = [])
Возвращает элементы с оценкой между $min и $max. | |
| array | zrevrangebyscore(string $key, mixed $min, mixed $max, array $options = [])
Возвращает элементы с оценкой между $min и $max. | |
| int | zinterstore(string $output, array $keys, array $options = [])
Найти пересечение между множествами и сохранить в новом множестве. | |
| int | zunionstore(string $output, array $keys, array $options = [])
Найти объединение между множествами и сохранить в новом множестве. | |
| mixed | scan(mixed $cursor, array $options = [])
Сканирует все ключи на основе параметров. | |
| mixed | zscan(string $key, mixed $cursor, array $options = [])
Сканирует заданное множество для всех значений на основе параметров. | |
| mixed | hscan(string $key, mixed $cursor, array $options = [])
Сканирует заданный хеш для всех значений на основе параметров. | |
| mixed | sscan(string $key, mixed $cursor, array $options = [])
Сканирует заданное множество для всех значений на основе параметров. | |
| Redis|array | pipeline(callable $callback = null)
Выполнить команды в конвейере. | |
| Redis|array | transaction(callable $callback = null)
Выполнить команды в транзакции. | |
| mixed | evalsha(string $script, int $numkeys, mixed ...$arguments)
Выполнить скрипт LUA на стороне сервера, используя SHA1-хэш скрипта вместо самого скрипта. | |
| mixed | eval(string $script, int $numberOfKeys, dynamic ...$arguments)
Выполнить скрипт и вернуть его результат. | |
| mixed | flushdb()
Очистить выбранную базу данных Redis. | |
| mixed | executeRaw(array $parameters)
Выполнить необработанную команду. | |
| void | disconnect()
Отключиться от экземпляра Redis. |
Подробности
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательский макрос.
static void mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрирован ли макрос.
static void flushMacros()
Очистить существующие макросы.
static mixed __callStatic(string $method, array $parameters)
Динамически обрабатывать вызовы класса.
mixed __call(string $method, array $parameters)
Передать другие вызовы методов базовому клиенту.
void createSubscription(array|string $channels, Closure $callback, string $method = 'subscribe')
Подписаться на набор заданных каналов для сообщений.
ConcurrencyLimiterBuilder funnel(string $name)
Канал обратного вызова для максимального количества одновременных выполнений.
DurationLimiterBuilder throttle(string $name)
Ограничение вызова обратного вызова для максимального количества исполнений за заданный период времени.
mixed client()
Получение основного клиента Redis.
void subscribe(array|string $channels, Closure $callback)
Подписка на набор заданных каналов для получения сообщений.
void psubscribe(array|string $channels, Closure $callback)
Подписка на набор заданных каналов с подстановочными знаками.
mixed command(string $method, array $parameters = [])
Выполнение команды в базе данных Redis.
protected void event(mixed $event)
Отправка заданного события, если это возможно.
void listen(Closure $callback)
Регистрация обработчика команд Redis в соединении.
string|null getName()
Получение имени соединения.
$this setName(string $name)
Установка имени соединения.
Dispatcher getEventDispatcher()
Получение диспетчера событий, используемого соединением.
void setEventDispatcher(Dispatcher $events)
Установка экземпляра диспетчера событий в соединении.
void unsetEventDispatcher()
Сброс экземпляра диспетчера событий в соединении.
array pack(array $values)
Подготавливает заданные значения для использования с командой eval, включая сериализацию и сжатие.
bool compressed()
Определение, включено ли сжатие.
bool lzfCompressed()
Определение, включено ли сжатие LZF.
bool zstdCompressed()
Определение, включено ли сжатие ZSTD.
bool lz4Compressed()
Определение, включено ли сжатие LZ4.
protected bool supportsPacking()
Определение, поддерживает ли текущая версия расширения PhpRedis упаковку.
protected bool supportsLzf()
Определение, поддерживает ли текущая версия расширения PhpRedis сжатие LZF.
protected bool supportsZstd()
Определение, поддерживает ли текущая версия расширения PhpRedis сжатие Zstd.
protected bool phpRedisVersionAtLeast(string $version)
Определение, является ли версия расширения PhpRedis не ниже заданной версии.
void __construct(Redis $client, callable $connector = null, array $config = [])
Создание нового соединения PhpRedis.
string|null get(string $key)
Возвращает значение заданного ключа.
array mget(array $keys)
Получить значения всех заданных ключей.
bool set(string $key, mixed $value, string|null $expireResolution = null, int|null $expireTTL = null, string|null $flag = null)
Установить строковое значение в аргументе в качестве значения ключа.
int setnx(string $key, string $value)
Установить заданный ключ, если он не существует.
array hmget(string $key, mixed ...$dictionary)
Получить значение заданных полей хэша.
int hmset(string $key, mixed ...$dictionary)
Установить заданные поля хэша в их соответствующие значения.
int hsetnx(string $hash, string $key, string $value)
Установить заданное поле хэша, если оно не существует.
int|false lrem(string $key, int $count, mixed $value)
Удаляет первые count вхождений элемента value из списка.
array|null blpop(mixed ...$arguments)
Удаляет и возвращает первый элемент списка, хранящегося по ключу.
array|null brpop(mixed ...$arguments)
Удаляет и возвращает последний элемент списка, хранящегося по ключу.
mixed|false spop(string $key, int|null $count = 1)
Удаляет и возвращает случайный элемент из значения множества по ключу.
int zadd(string $key, mixed ...$dictionary)
Добавить один или несколько элементов во множество или обновить его оценку, если он уже существует.
array zrangebyscore(string $key, mixed $min, mixed $max, array $options = [])
Возвращает элементы с оценкой между $min и $max.
array zrevrangebyscore(string $key, mixed $min, mixed $max, array $options = [])
Возвращает элементы с оценкой между $min и $max.
int zinterstore(string $output, array $keys, array $options = [])
Найти пересечение между множествами и сохранить в новое множество.
int zunionstore(string $output, array $keys, array $options = [])
Найти объединение между множествами и сохранить в новое множество.
mixed scan(mixed $cursor, array $options = [])
Сканирует все ключи на основе параметров.
mixed zscan(string $key, mixed $cursor, array $options = [])
Сканирует заданное множество для всех значений на основе параметров.
mixed hscan(string $key, mixed $cursor, array $options = [])
Сканирует заданный хэш для всех значений на основе параметров.
mixed sscan(string $key, mixed $cursor, array $options = [])
Сканирует заданное множество для всех значений на основе параметров.
Redis|array pipeline(callable $callback = null)
Выполнить команды в конвейере.
Redis|array transaction(callable $callback = null)
Выполнить команды в транзакции.
mixed evalsha(string $script, int $numkeys, mixed ...$arguments)
Выполнить скрипт LUA на сервере, используя SHA1 хэш скрипта вместо самого скрипта.
mixed eval(string $script, int $numberOfKeys, dynamic ...$arguments)
Выполнить скрипт и вернуть его результат.
mixed flushdb()
Очистить выбранную базу данных Redis.
mixed executeRaw(array $parameters)
Выполнить необработанную команду.
void disconnect()
Отключиться от экземпляра Redis.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Redis/Connections/PhpRedisConnection.html
