Spec-Zone.ru › Laravel 7

PhpRedisConnection

class PhpRedisConnection extends Connection implements Connection mixin Redis (View source)

Особенности

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 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 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.
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.
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)

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

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

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

Отсоединяется от экземпляра Redis.

Подробности

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)

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

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

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

Parameters

string $name

Return Value

bool

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

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

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Передает другие вызовы метода вниз к базовому клиенту.

Parameters

string $method
array $parameters

Return Value

mixed

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

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

Parameters

array|string $channels
Closure $callback
string $method

Return Value

void

ConcurrencyLimiterBuilder funnel(string $name)

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

Parameters

string $name

Return Value

ConcurrencyLimiterBuilder

DurationLimiterBuilder throttle(string $name)

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

Parameters

string $name

Return Value

DurationLimiterBuilder

mixed client()

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

Return Value

mixed

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

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

Parameters

array|string $channels
Closure $callback

Return Value

void

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

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

Parameters

array|string $channels
Closure $callback

Return Value

void

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

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

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

RedisException

protected void event(mixed $event)

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

Parameters

mixed $event

Return Value

void

void listen(Closure $callback)

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

Parameters

Closure $callback

Return Value

void

string|null getName()

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

Return Value

string|null

$this setName(string $name)

Установить имя соединения.

Параметры

string $name

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

$this

Диспетчер событий getEventDispatcher()

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

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

Диспетчер событий

void setEventDispatcher(Dispatcher $events)

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

Параметры

Диспетчер событий $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)

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

Параметры

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 на сервере, используя SHA1 хеш скрипта вместо самого скрипта.

Параметры

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

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

mixed

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

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

Параметры

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

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

mixed

void flushdb()

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

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

void

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/7.x/Illuminate/Redis/Connections/PhpRedisConnection.html

Spec-Zone.ru

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