Spec-Zone.ru › Laravel 6

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)

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

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

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

из Macroable
static bool hasMacro(string $name)

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

из Macroable
static mixed __callStatic(string $method, array $parameters)

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

из Macroable
mixed __call(string $method, array $parameters)

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

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

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

ConcurrencyLimiterBuilder funnel(string $name)

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

из Connection
DurationLimiterBuilder throttle(string $name)

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

из Connection
mixed client()

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

из 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)

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

из Connection
void listen(Closure $callback)

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

из Connection
string|null getName()

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

из Connection
$this setName(string $name)

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

из Connection
Dispatcher getEventDispatcher()

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

из Connection
void setEventDispatcher(Dispatcher $events)

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

из Connection
void unsetEventDispatcher()

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

из 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)

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

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

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

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

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

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 = [])

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

смешанный hscan(string $key, mixed $cursor, array $options = [])

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

смешанный sscan(string $key, mixed $cursor, array $options = [])

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

Redis|массив pipeline(callable $callback = null)

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

Redis|массив transaction(callable $callback = null)

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

смешанный evalsha(string $script, int $numkeys, mixed ...$arguments)

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

смешанный eval(string $script, int $numberOfKeys, dynamic ...$arguments)

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

пусто flushdb()

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

смешанный executeRaw(array $parameters)

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

пусто disconnect()

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

Подробности

static пусто macro(string $name, object|callable $macro)

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

Параметры

строка $name
объект|вызываемая функция $macro

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

пусто

static пусто mixin(object $mixin, bool $replace = true)

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

Параметры

объект $mixin
булево $replace

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

пусто

Исключения

ReflectionException

static логическое hasMacro(string $name)

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

Параметры

строка $name

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

логическое

static смешанный __callStatic(string $method, array $parameters)

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

Параметры

строка $method
массив $parameters

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

смешанный

Исключения

BadMethodCallException

смешанный __call(string $method, array $parameters)

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

Параметры

строка $method
массив $parameters

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

смешанный

пусто createSubscription(array|string $channels, Closure $callback, string $method = 'subscribe')

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

Параметры

массив|строка $channels
Closure $callback
строка $method

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

пусто

ConcurrencyLimiterBuilder funnel(string $name)

Перенаправить вызов функции для максимального числа одновременных выполнений.

Параметры

строка $name

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

ConcurrencyLimiterBuilder

DurationLimiterBuilder throttle(string $name)

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

Параметры

строка $name

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

DurationLimiterBuilder

смешанный client()

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

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

смешанный

пусто subscribe(array|string $channels, Closure $callback)

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

Параметры

массив|строка $channels
Closure $callback

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

пусто

пусто psubscribe(array|string $channels, Closure $callback)

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

Параметры

массив|строка $channels
Closure $callback

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

пусто

смешанный command(string $method, array $parameters = [])

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

Параметры

строка $method
массив $parameters

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

смешанный

protected пусто event(mixed $event)

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

Параметры

смешанный $event

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

пусто

пусто listen(Closure $callback)

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

Параметры

Closure $callback

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

пусто

строка|null getName()

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

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

строка|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
END_OF_DOCUMENT_MARKER

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

Spec-Zone.ru

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