PhpRedisClusterConnection

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

Трейты

Свойства

статический защищенный массив	$macros	Зарегистрированные строковые макросы.	из Macroable
защищенный Redis	$client	Клиент Redis.	из Connection
защищенный строка\|null	$name	Имя подключения к Redis.	из Connection
защищенный Dispatcher	$events	Экземпляр диспетчера событий.	из Connection
защищенный bool\|null	$supportsPacking	Указывает, поддерживает ли Redis упаковку.	из PacksPhpRedisValues
защищенный bool\|null	$supportsLzf	Указывает, поддерживает ли Redis сжатие LZF.	из PacksPhpRedisValues
защищенный bool\|null	$supportsZstd	Указывает, поддерживает ли Redis сжатие Zstd.	из PacksPhpRedisValues
защищенный вызываемый	$connector	Обратный вызов создания соединения.	из PhpRedisConnection
защищенный массив	$config	Массив конфигурации подключения.	из 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
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) Подготавливает заданные значения для использования с командой `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 $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 $callback = null) Выполнить команды в конвейере.	from PhpRedisConnection
Redis\|array	transaction(callable $callback = null) Выполнить команды в транзакции.	from PhpRedisConnection
mixed	evalsha(string $script, int $numkeys, mixed ...$arguments) Оценить скрипт LUA на стороне сервера из SHA1-хеша скрипта вместо самого скрипта.	from PhpRedisConnection
mixed	eval(string $script, int $numberOfKeys, dynamic ...$arguments) Оценить скрипт и вернуть его результат.	from PhpRedisConnection
mixed	flushdb() Очистить выбранную базу данных Redis на всех узлах-мастерах.
mixed	executeRaw(array $parameters) Выполнить сырую команду.	from PhpRedisConnection
void	disconnect() Отсоединиться от экземпляра Redis.	from PhpRedisConnection

Details

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

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

Parameters

string	$name
object\|callable	$macro

Return Value

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 void event(mixed $event)

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

Параметры

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

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

Параметры

Redis	$client
callable	$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 вхождений элемента value из списка.

Параметры

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 $callback = null)

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

Параметры

callable

$callback

Значение результата

Redis|array

Redis|array transaction(callable $callback = null)

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

Параметры

callable

$callback

Значение результата

Redis|array

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

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

Параметры

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

Значение результата

mixed

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

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

Параметры

string	$script
int	$numberOfKeys
dynamic	...$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/8.x/Illuminate/Redis/Connections/PhpRedisClusterConnection.html