RedisBroadcaster

class RedisBroadcaster extends Broadcaster (View source)

Свойства

protected array	$channels	Зарегистрированные авторизаторы каналов.	из Broadcaster
protected array	$channelOptions	Зарегистрированные параметры каналов.	из Broadcaster
protected BindingRegistrar	$bindingRegistrar	Экземпляр регистратора привязок.	из Broadcaster
protected Factory	$redis	Экземпляр Redis.
protected string	$connection	Подключение Redis для вещания.
protected string	$prefix	Префикс ключа Redis.

Методы

$this

channel(string $channel, callable|string $callback, array $options = [])

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

из Broadcaster

mixed

verifyUserCanAccessChannel(Request $request, string $channel)

Проверить возможность доступа пользователя к каналу.

из Broadcaster

array

extractAuthParameters(string $pattern, string $channel, callable|string $callback)

Извлечь параметры из шаблона и канала.

из Broadcaster

ReflectionParameter[]

extractParameters(callable|string $callback)

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

из Broadcaster

ReflectionParameter[]

extractParametersFromClass(string $callback)

Извлечь параметры из метода "join" канала класса.

из Broadcaster

array

extractChannelKeys(string $pattern, string $channel)

Извлечь ключи канала из имени канала.

из Broadcaster

mixed

resolveBinding(string $key, string $value, array $callbackParameters)

Разрешить привязку заданного параметра.

из Broadcaster

mixed

resolveExplicitBindingIfPossible(string $key, mixed $value)

Разрешить явную привязку параметра, если применимо.

из Broadcaster

mixed

resolveImplicitBindingIfPossible(string $key, mixed $value, array $callbackParameters)

Разрешить неявную привязку параметра, если применимо.

из Broadcaster

bool

isImplicitlyBindable(string $key, ReflectionParameter $parameter)

Определить, можно ли выполнить неявную привязку для заданного ключа и параметра.

из Broadcaster

array

formatChannels(array $channels)

Отформатировать массив каналов в массив строк.

BindingRegistrar

binder()

Получить экземпляр регистратора привязок моделей.

из Broadcaster

callable

normalizeChannelHandlerToCallable(mixed $callback)

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

из Broadcaster

mixed

retrieveUser(Request $request, string $channel)

Получить авторизованного пользователя, используя настроенную стражу (если есть).

из Broadcaster

array

retrieveChannelOptions(string $channel)

Получить параметры для определенного канала.

из Broadcaster

bool

channelNameMatchesPattern(string $channel, string $pattern)

Проверить, соответствует ли имя канала шаблону из зарегистрированных каналов.

из Broadcaster

bool

isGuardedChannel(string $channel)

Возвращает true, если канал защищен аутентификацией.

из UsePusherChannelConventions

string

normalizeChannelName(string $channel)

Удалить префикс из имени канала.

из UsePusherChannelConventions

void

__construct(Factory $redis, string|null $connection = null, string $prefix = '')

Создать новый экземпляр вещателя.

mixed

auth(Request $request)

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

mixed

validAuthenticationResponse(Request $request, mixed $result)

Возвратить действительный ответ на аутентификацию.

void

broadcast(array $channels, string $event, array $payload = [])

Отобразить заданное событие.

string

broadcastMultipleChannelsScript()

Получить скрипт Lua для вещания на множество каналов.

Детали

$this channel(string $channel, callable|string $callback, array $options = [])

Зарегистрировать аутентификатор канала.

Параметры

string	$channel
callable\|string	$callback
array	$options

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

$this

protected mixed verifyUserCanAccessChannel(Request $request, string $channel)

Проверить аутентификацию входящего запроса для данного канала.

Параметры

Request	$request
string	$channel

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

mixed

Исключения

AccessDeniedHttpException

protected array extractAuthParameters(string $pattern, string $channel, callable|string $callback)

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

Параметры

string	$pattern
string	$channel
callable\|string	$callback

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

array

protected ReflectionParameter[] extractParameters(callable|string $callback)

Извлекает параметры из того, что пользователь передал для обработки аутентификации канала.

Параметры

callable|string

$callback

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

ReflectionParameter[]

Исключения

Exception

protected ReflectionParameter[] extractParametersFromClass(string $callback)

Извлекает параметры из метода «join» канала класса.

Параметры

string

$callback

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

ReflectionParameter[]

Исключения

Exception

protected array extractChannelKeys(string $pattern, string $channel)

Извлечь ключи канала из входящего имени канала.

Параметры

string	$pattern
string	$channel

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

array

protected mixed resolveBinding(string $key, string $value, array $callbackParameters)

Разрешить привязку данного параметра.

Параметры

string	$key
string	$value
array	$callbackParameters

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

mixed

protected mixed resolveExplicitBindingIfPossible(string $key, mixed $value)

Разрешить явную привязку параметра, если применимо.

Параметры

string	$key
mixed	$value

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

mixed

protected mixed resolveImplicitBindingIfPossible(string $key, mixed $value, array $callbackParameters)

Разрешить неявную привязку параметра, если применимо.

Параметры

string	$key
mixed	$value
array	$callbackParameters

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

mixed

Исключения

AccessDeniedHttpException

protected bool isImplicitlyBindable(string $key, ReflectionParameter $parameter)

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

Параметры

string	$key
ReflectionParameter	$parameter

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

bool

protected array formatChannels(array $channels)

Отформатировать массив каналов в массив строк.

Параметры

array

$channels

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

array

protected BindingRegistrar binder()

Получить экземпляр регистратора привязки модели.

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

BindingRegistrar

protected callable normalizeChannelHandlerToCallable(mixed $callback)

Нормализовать заданный обратный вызов в вызываемый объект.

Параметры

mixed

$callback

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

callable

protected mixed retrieveUser(Request $request, string $channel)

Получить аутентифицированного пользователя, используя настроенного охранника (если есть).

Параметры

Request	$request
string	$channel

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

mixed

protected array retrieveChannelOptions(string $channel)

Получить параметры для определенного канала.

Параметры

string

$channel

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

array

protected bool channelNameMatchesPattern(string $channel, string $pattern)

Проверить, соответствует ли имя канала шаблону зарегистрированных каналов.

Параметры

string	$channel
string	$pattern

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

bool

bool isGuardedChannel(string $channel)

Возвращает true, если канал защищен аутентификацией.

Параметры

string

$channel

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

bool

END_OF_DOCUMENT_MARKER

string normalizeChannelName(string $channel)

Удалить префикс из имени канала.

Parameters

string

$channel

Return Value

string

void __construct(Factory $redis, string|null $connection = null, string $prefix = '')

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

Parameters

Factory	$redis
string\|null	$connection
string	$prefix

Return Value

void

mixed auth(Request $request)

Проверить аутентификацию входящего запроса для заданного канала.

Parameters

Request

$request

Return Value

mixed

Exceptions

AccessDeniedHttpException

mixed validAuthenticationResponse(Request $request, mixed $result)

Возвратить корректный ответ аутентификации.

Parameters

Request	$request
mixed	$result

Return Value

mixed

void broadcast(array $channels, string $event, array $payload = [])

Транслировать заданное событие.

Parameters

array	$channels
string	$event
array	$payload

Return Value

void

protected string broadcastMultipleChannelsScript()

Получить Lua-скрипт для трансляции на множество каналов.

ARGV[1] - Загрузка ARGV[2...] - Каналы

Return Value

string

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Broadcasting/Broadcasters/RedisBroadcaster.html