PhpRedisClusterConnection

class PhpRedisClusterConnection extends PhpRedisConnection (View source)

Особенности

Свойства

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 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 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
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
void	flushdb() Очищает выбранную базу данных Redis.	from PhpRedisConnection
mixed	executeRaw(array $parameters) Выполняет исходную команду.	from PhpRedisConnection
void	disconnect() Отключается от экземпляра Redis.	from 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 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

END_OF_DOCUMENT_MARKER

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

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

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)

Установить значение поля хэш-таблицы, если оно не существует.

Parameters

string	$hash
string	$key
string	$value

Return Value

int

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

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

Parameters

string	$key
int	$count
mixed	$value

Return Value

int|false

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

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

Parameters

mixed

...$arguments

Return Value

array|null

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

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

Parameters

mixed

...$arguments

Return Value

array|null

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

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

Parameters

string	$key
int\|null	$count

Return Value

mixed|false

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

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

Parameters

string	$key
mixed	...$dictionary

Return Value

int

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

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

Parameters

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

Return Value

array

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

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

Parameters

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

Return Value

array

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

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

Parameters

string	$output
array	$keys
array	$options

Return Value

int

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

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

Parameters

string	$output
array	$keys
array	$options

Return Value

int

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

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

Parameters

mixed	$cursor
array	$options

Return Value

mixed

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

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

Parameters

string	$key
mixed	$cursor
array	$options

Return Value

mixed

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

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

Parameters

string	$key
mixed	$cursor
array	$options

Return Value

mixed

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

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

Parameters

string	$key
mixed	$cursor
array	$options

Return Value

mixed

Redis|array pipeline(callable $callback = null)

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

Parameters

callable

$callback

Return Value

Redis|array

Redis|array transaction(callable $callback = null)

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

Parameters

callable

$callback

Return Value

Redis|array

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

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

Parameters

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

Return Value

mixed

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

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

Parameters

string	$script
int	$numberOfKeys
dynamic	...$arguments

Return Value

mixed

void flushdb()

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

Return Value

void

mixed executeRaw(array $parameters)

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

Parameters

array

$parameters

Return Value

mixed

void disconnect()

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

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

void

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