Spec-Zone.ru › Laravel 11

PhpRedisConnection

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

Трейты

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

Обратный вызов создания подключения.
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 void flushMacros()

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

 из 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.
array parseParametersForEvent(array $parameters)

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

 из Connection
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
array pack(array $values)

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

 из PacksPhpRedisValues
bool compressed()

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

 из PacksPhpRedisValues
bool lzfCompressed()

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

 из PacksPhpRedisValues
bool zstdCompressed()

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

 из PacksPhpRedisValues
bool lz4Compressed()

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

 из PacksPhpRedisValues
bool supportsPacking()

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

 из PacksPhpRedisValues
bool supportsLzf()

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

 из PacksPhpRedisValues
bool supportsZstd()

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

 из PacksPhpRedisValues
bool phpRedisVersionAtLeast(string $version)

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

 из PacksPhpRedisValues
void __construct(Redis $client, callable|null $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|null $callback = null)

Выполнить команды в конвейере.
Redis|array transaction(callable|null $callback = null)

Выполнить команды в транзакции.
mixed evalsha(string $script, int $numkeys, mixed ...$arguments)

Вычислить LUA-скрипт на стороне сервера из SHA1-хеша скрипта вместо самого скрипта.
mixed eval(string $script, int $numberOfKeys, mixed ...$arguments)

Вычислить скрипт и вернуть его результат.
mixed flushdb()

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

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

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

Подробности

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

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)

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

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 array parseParametersForEvent(array $parameters)

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

Parameters

array $parameters

Return Value

array

protected void event(mixed $event) deprecated

deprecated

since Laravel 11.x

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

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)

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

Parameters

string $name

Return Value

$this

Dispatcher getEventDispatcher()

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

Return Value

Dispatcher

void setEventDispatcher(Dispatcher $events)

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

Parameters

Dispatcher $events

Return Value

void

void unsetEventDispatcher()

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

Return Value

void

array pack(array $values)

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

Parameters

array $values

Return Value

array

bool compressed()

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

Return Value

bool

bool lzfCompressed()

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

Return Value

bool

bool zstdCompressed()

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

Return Value

bool

bool lz4Compressed()

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

Return Value

bool

protected bool supportsPacking()

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

Return Value

bool

protected bool supportsLzf()

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

Return Value

bool

protected bool supportsZstd()

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

Return Value

bool

protected bool phpRedisVersionAtLeast(string $version)

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

Parameters

string $version

Return Value

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 вхождений элемента 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|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/PhpRedisConnection.html

Spec-Zone.ru

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