PhpRedisConnection
class PhpRedisConnection extends Connection implements Connection mixin Redis (View source)
Методы
| 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. | 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, mixed ...$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 вхождений элемента 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, mixed ...$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/10.x/Illuminate/Redis/Connections/PhpRedisConnection.html
