Spec-Zone.ru › Laravel 11

PhpRedisClusterConnection

класс PhpRedisClusterConnection расширяет PhpRedisConnection (Просмотреть исходный код)

Свойства

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

Обратный вызов для создания подключения.

 from PhpRedisConnection
protected array $config

Массив конфигурации подключения.

 from PhpRedisConnection

Методы

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)

Динамически обработать вызовы класса.

 from Macroable
void createSubscription(array|string $channels, Closure $callback, string $method = 'subscribe')

Подписаться на набор заданных каналов для сообщений.

 from PhpRedisConnection
ConcurrencyLimiterBuilder funnel(string $name)

Направить обратный вызов для максимального числа одновременных выполнений.

 from Connection
DurationLimiterBuilder throttle(string $name)

Ограничить вызов обратного вызова для максимального числа выполнений за заданный период.

 from Connection
mixed client()

Получить базовый клиент Redis.

 from Connection
void subscribe(array|string $channels, Closure $callback)

Подписаться на набор заданных каналов для сообщений.

 from PhpRedisConnection
void psubscribe(array|string $channels, Closure $callback)

Подписаться на набор заданных каналов с подстановками.

 from PhpRedisConnection
mixed command(string $method, array $parameters = [])

Выполнить команду на базе данных Redis.

 from PhpRedisConnection
array parseParametersForEvent(array $parameters)

Обработать параметры команды для отправки события.

 from Connection
void event(mixed $event) deprecated

Вызвать заданное событие, если возможно.

 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)

Подготавливает заданные значения для использования с командой eval, включая сериализацию и сжатие.

 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|null $connector = null, array $config = [])

Создать новое соединение PhpRedis.

 from PhpRedisConnection
string|null get(string $key)

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

 from PhpRedisConnection
array mget(array $keys)

Получить значения всех заданных ключей.

 from PhpRedisConnection
bool set(string $key, mixed $value, string|null $expireResolution = null, int|null $expireTTL = null, string|null $flag = null)

Установить строковое значение в аргументе в качестве значения ключа.

 from PhpRedisConnection
int setnx(string $key, string $value)

Установить заданный ключ, если он не существует.

 from PhpRedisConnection
array hmget(string $key, mixed ...$dictionary)

Получить значения заданных полей хеша.

 from PhpRedisConnection
int hmset(string $key, mixed ...$dictionary)

Установить заданные поля хеша со значениями.

 from PhpRedisConnection
int hsetnx(string $hash, string $key, string $value)

Установить заданное поле хеша, если оно не существует.

 from PhpRedisConnection
int|false lrem(string $key, int $count, mixed $value)

Удаляет первые count вхождений элемента value из списка.

 from PhpRedisConnection
array|null blpop(mixed ...$arguments)

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

 from PhpRedisConnection
array|null brpop(mixed ...$arguments)

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

 from PhpRedisConnection
mixed|false spop(string $key, int|null $count = 1)

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

 from PhpRedisConnection
int zadd(string $key, mixed ...$dictionary)

Добавляет один или несколько элементов в упорядоченное множество или обновляет его оценку, если элемент уже существует.

 from PhpRedisConnection
array zrangebyscore(string $key, mixed $min, mixed $max, array $options = [])

Возвращает элементы с оценкой между $min и $max.

 from PhpRedisConnection
array zrevrangebyscore(string $key, mixed $min, mixed $max, array $options = [])

Возвращает элементы с оценкой между $min и $max в обратном порядке.

 from PhpRedisConnection
int zinterstore(string $output, array $keys, array $options = [])

Находит пересечение множеств и сохраняет его в новое множество.

 from PhpRedisConnection
int zunionstore(string $output, array $keys, array $options = [])

Находит объединение множеств и сохраняет его в новое множество.

 from PhpRedisConnection
mixed scan(mixed $cursor, array $options = [])

Сканирует все ключи на основе опций.

 from PhpRedisConnection
mixed zscan(string $key, mixed $cursor, array $options = [])

Сканирует заданный набор для всех значений на основе параметров.

 from PhpRedisConnection
mixed hscan(string $key, mixed $cursor, array $options = [])

Сканирует заданный хеш для всех значений на основе параметров.

 from PhpRedisConnection
mixed sscan(string $key, mixed $cursor, array $options = [])

Сканирует заданный набор для всех значений на основе параметров.

 from PhpRedisConnection
Redis|array pipeline(callable|null $callback = null)

Выполнить команды в конвейере.

 from PhpRedisConnection
Redis|array transaction(callable|null $callback = null)

Выполнить команды в транзакции.

 from PhpRedisConnection
mixed evalsha(string $script, int $numkeys, mixed ...$arguments)

Оценить LUA скрипт на стороне сервера по SHA1 хэшу скрипта, а не по самому скрипту.

 from PhpRedisConnection
mixed eval(string $script, int $numberOfKeys, mixed ...$arguments)

Оценить скрипт и вернуть его результат.

 from PhpRedisConnection
mixed flushdb()

Очистить выбранную базу данных Redis на всех узлах-мастерах.
mixed executeRaw(array $parameters)

Выполнить сырую команду.

 из PhpRedisConnection
void disconnect()

Отключиться от экземпляра Redis.

 из PhpRedisConnection

Подробности

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательское макро.

Параметры

string $name
object|callable $macro

Возвращаемое значение

void

static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

Параметры

object $mixin
bool $replace

Возвращаемое значение

void

Исключения

ReflectionException

static bool hasMacro(string $name)

Проверить, зарегистрировано ли макро.

Параметры

string $name

Возвращаемое значение

bool

static void flushMacros()

Очистить существующие макросы.

Значение возврата

void

static mixed __callStatic(string $method, array $parameters)

Динамически обрабатывать вызовы класса.

Параметры

string $method
array $parameters

Значение возврата

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обрабатывать вызовы класса.

Параметры

string $method
array $parameters

Значение возврата

mixed

Исключения

BadMethodCallException

void createSubscription(array|string $channels, Closure $callback, string $method = 'subscribe')

Подписаться на набор заданных каналов для сообщений.

Параметры

array|string $channels
Closure $callback
string $method

Значение возврата

void

ConcurrencyLimiterBuilder funnel(string $name)

Направить обратный вызов для максимального количества одновременных выполнений.

Параметры

string $name

Значение возврата

ConcurrencyLimiterBuilder

DurationLimiterBuilder throttle(string $name)

Ограничить вызов обратного вызова для максимального числа выполнений в течение заданного периода.

Параметры

string $name

Значение возврата

DurationLimiterBuilder

mixed client()

Получить базовый клиент Redis.

Значение возврата

mixed

void subscribe(array|string $channels, Closure $callback)

Подписаться на набор заданных каналов для сообщений.

Параметры

array|string $channels
Closure $callback

Значение возврата

void

void psubscribe(array|string $channels, Closure $callback)

Подписаться на набор заданных каналов с подстановкой.

Параметры

array|string $channels
Closure $callback

Возвращаемое значение

void

mixed command(string $method, array $parameters = [])

Выполнить команду в базе данных Redis.

Параметры

string $method
array $parameters

Возвращаемое значение

mixed

Исключения

RedisException

protected array parseParametersForEvent(array $parameters)

Обработать параметры команды для отправки события.

Параметры

array $parameters

Возвращаемое значение

array

protected void event(mixed $event) устаревшее

устаревшее

since Laravel 11.x

Сгенерировать заданное событие, если возможно.

Параметры

mixed $event

Возвращаемое значение

void

void listen(Closure $callback)

Зарегистрировать слушателя команд Redis с подключением.

Параметры

Closure $callback

Возвращаемое значение

void

string|null getName()

Получить имя подключения.

Возвращаемое значение

string|null

$this setName(string $name)

Установить имя подключения.

Параметры

string $name

Возвращаемое значение

$this

Dispatcher getEventDispatcher()

Получить диспетчер событий, используемый подключением.

Возвращаемое значение

Dispatcher

void setEventDispatcher(Dispatcher $events)

Установить экземпляр диспетчера событий для подключения.

Параметры

Dispatcher $events

Возвращаемое значение

void

void unsetEventDispatcher()

Сбросьте экземпляр диспетчера событий в соединении.

Значение возврата

void

array pack(array $values)

Подготавливает заданные значения для использования с командой eval, включая сериализацию и сжатие.

Параметры

array $values

Значение возврата

array

bool compressed()

Определите, включено ли сжатие.

Значение возврата

bool

bool lzfCompressed()

Определите, включено ли сжатие LZF.

Значение возврата

bool

bool zstdCompressed()

Определите, включено ли сжатие ZSTD.

Значение возврата

bool

bool lz4Compressed()

Определите, включено ли сжатие LZ4.

Значение возврата

bool

protected bool supportsPacking()

Определите, поддерживает ли текущая версия расширения PhpRedis упаковку.

Значение возврата

bool

protected bool supportsLzf()

Определить, поддерживает ли текущая версия расширения PhpRedis сжатие LZF.

Возвращаемое значение

bool

protected bool supportsZstd()

Определить, поддерживает ли текущая версия расширения PhpRedis сжатие Zstd.

Возвращаемое значение

bool

protected bool phpRedisVersionAtLeast(string $version)

Определить, соответствует ли версия расширения PhpRedis заданной версии или выше.

Параметры

string $version

Возвращаемое значение

bool

void __construct(Redis $client, callable|null $connector = null, array $config = [])

Создать новое подключение PhpRedis.

Параметры

Redis $client
callable|null $connector
array $config

Возвращаемое значение

void

string|null get(string $key)

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

Параметры

string $key

Возвращаемое значение

string|null

array mget(array $keys)

Получить значения всех заданных ключей.

Параметры

array $keys

Возвращаемое значение

array

bool set(string $key, mixed $value, string|null $expireResolution = null, int|null $expireTTL = null, string|null $flag = null)

Установить строковое значение аргумента в качестве значения ключа.

Параметры

string $key
mixed $value
string|null $expireResolution
int|null $expireTTL
string|null $flag

Возвращаемое значение

bool

int setnx(string $key, string $value)

Установить заданный ключ, если он не существует.

Параметры

string $key
string $value

Возвращаемое значение

int

array hmget(string $key, mixed ...$dictionary)

Получить значение заданных полей хеш-таблицы.

Параметры

string $key
mixed ...$dictionary

Возвращаемое значение

array

int hmset(string $key, mixed ...$dictionary)

Установите заданные поля хеша в соответствующие значения.

Параметры

string $key
mixed ...$dictionary

Значение возврата

int

int hsetnx(string $hash, string $key, string $value)

Установите заданное поле хеша, если оно не существует.

Параметры

string $hash
string $key
string $value

Значение возврата

int

int|false lrem(string $key, int $count, mixed $value)

Удаляет первые count вхождений элемента значения из списка.

Параметры

string $key
int $count
mixed $value

Значение возврата

int|false

array|null blpop(mixed ...$arguments)

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

Параметры

mixed ...$arguments

Значение возврата

array|null

array|null brpop(mixed ...$arguments)

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

Параметры

mixed ...$arguments

Значение возврата

array|null

mixed|false spop(string $key, int|null $count = 1)

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

Параметры

string $key
int|null $count

Возвращаемое значение

mixed|false

int zadd(string $key, mixed ...$dictionary)

Добавляет одного или нескольких членов в упорядоченное множество или обновляет его рейтинг, если он уже существует.

Параметры

string $key
mixed ...$dictionary

Возвращаемое значение

int

array zrangebyscore(string $key, mixed $min, mixed $max, array $options = [])

Возвращает элементы с рейтингом между $min и $max.

Параметры

string $key
mixed $min
mixed $max
array $options

Возвращаемое значение

array

array zrevrangebyscore(string $key, mixed $min, mixed $max, array $options = [])

Возвращает элементы с рейтингом между $min и $max.

Параметры

string $key
mixed $min
mixed $max
array $options

Возвращаемое значение

array

int zinterstore(string $output, array $keys, array $options = [])

Найти пересечение множеств и сохранить в новое множество.

Параметры

string $output
array $keys
array $options

Значение возврата

int

int zunionstore(string $output, array $keys, array $options = [])

Найти объединение множеств и сохранить в новое множество.

Параметры

string $output
array $keys
array $options

Значение возврата

int

mixed scan(mixed $cursor, array $options = [])

Сканирует все ключи на основе параметров.

Параметры

mixed $cursor
array $options

Значение возврата

mixed

mixed zscan(string $key, mixed $cursor, array $options = [])

Сканирует заданное множество по всем значениям на основе параметров.

Параметры

string $key
mixed $cursor
array $options

Значение возврата

mixed

mixed hscan(string $key, mixed $cursor, array $options = [])

Сканирует заданный хеш для всех значений на основе параметров.

Параметры

string $key
mixed $cursor
array $options

Значение возврата

mixed

mixed sscan(string $key, mixed $cursor, array $options = [])

Сканирует заданный набор для всех значений на основе параметров.

Параметры

string $key
mixed $cursor
array $options

Значение возврата

mixed

Redis|array pipeline(callable|null $callback = null)

Выполнить команды в потоке.

Параметры

callable|null $callback

Значение возврата

Redis|array

Redis|array transaction(callable|null $callback = null)

Выполнить команды в транзакции.

Параметры

callable|null $callback

Значение возврата

Redis|array

mixed evalsha(string $script, int $numkeys, mixed ...$arguments)

Выполнить LUA-скрипт на сервере, используя SHA1-хеш скрипта вместо самого скрипта.

Параметры

string $script
int $numkeys
mixed ...$arguments

Возвращаемое значение

mixed

mixed eval(string $script, int $numberOfKeys, mixed ...$arguments)

Выполнить скрипт и вернуть результат.

Параметры

string $script
int $numberOfKeys
mixed ...$arguments

Возвращаемое значение

mixed

mixed flushdb()

Очистить выбранную базу данных Redis на всех узлах-мастерах.

Возвращаемое значение

mixed

mixed executeRaw(array $parameters)

Выполнить сырую команду.

Параметры

array $parameters

Возвращаемое значение

mixed

void disconnect()

Отключиться от экземпляра Redis.

Возвращаемое значение

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Redis/Connections/PhpRedisClusterConnection.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API