PhpRedisConnection
класс PhpRedisConnection расширяет Connection и реализует Connection mixin Redis (Посмотреть исходный код)
Свойства
| PacksPhpRedisValues | |
| Macroable |
Свойства
| static protected array | $macros | Зарегистрированные макросы строк. | from Macroable |
| protected Redis | $client | Клиент Redis. | from Connection |
| protected string|null | $name | Имя подключения к Redis. | from Connection |
| protected Dispatcher | $events | Экземпляр диспетчера событий. | from Connection |
| protected bool|null | $supportsPacking | Указывает, поддерживает ли Redis упаковку. | from PacksPhpRedisValues |
| protected bool|null | $supportsLzf | Указывает, поддерживает ли Redis сжатие LZF. | from PacksPhpRedisValues |
| protected bool|null | $supportsZstd | Указывает, поддерживает ли Redis сжатие Zstd. | from 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. | |
| array | parseParametersForEvent(array $parameters)
Обработать параметры команды для отправки события. | from Connection |
| 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. | из PacksPhpRedisValues |
| bool | zstdCompressed()
Определить, включена ли сжатие ZSTD. | из PacksPhpRedisValues |
| bool | lz4Compressed()
Определить, включена ли сжатие LZ4. | из PacksPhpRedisValues |
| bool | supportsPacking()
Определить, поддерживает ли текущая версия расширения PhpRedis упаковку. | из PacksPhpRedisValues |
| bool | supportsLzf()
Определить, поддерживает ли текущая версия расширения PhpRedis сжатие LZF. | из PacksPhpRedisValues |
| bool | supportsZstd()
Определить, поддерживает ли текущая версия расширения PhpRedis сжатие Zstd. | из PacksPhpRedisValues |
| bool | phpRedisVersionAtLeast(string $version)
Определить, соответствует ли версия расширения PhpRedis заданной версии или выше. | из 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 array parseParametersForEvent(array $parameters)
Разбор параметров команды для отправки события.
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 вхождений элемента значения из списка.
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/9.x/Illuminate/Redis/Connections/PhpRedisConnection.html
