Вещатель

абстрактный класс Broadcaster реализует Broadcaster (View source)

Свойства

защищённый массив	$channels	Зарегистрированные аутентификаторы каналов.
защищённый массив	$channelOptions	Зарегистрированные параметры каналов.
защищённый BindingRegistrar	$bindingRegistrar	Экземпляр регистратора привязок.

Методы

$this

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

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

mixed

verifyUserCanAccessChannel(Request $request, string $channel)

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

array

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

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

ReflectionParameter[]

extractParameters(callable|string $callback)

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

ReflectionParameter[]

extractParametersFromClass(string $callback)

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

array

extractChannelKeys(string $pattern, string $channel)

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

mixed

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

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

mixed

resolveExplicitBindingIfPossible(string $key, mixed $value)

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

mixed

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

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

bool

isImplicitlyBindable(string $key, ReflectionParameter $parameter)

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

array

formatChannels(array $channels)

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

BindingRegistrar

binder()

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

callable

normalizeChannelHandlerToCallable(mixed $callback)

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

mixed

retrieveUser(Request $request, string $channel)

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

array

retrieveChannelOptions(string $channel)

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

bool

channelNameMatchesPattern(string $channel, string $pattern)

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

Подробности

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

Регистрация аутентификатора канала.

Параметры

HasBroadcastChannel\|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)

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

Parameters

string	$key
mixed	$value

Return Value

mixed

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

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

Parameters

string	$key
mixed	$value
array	$callbackParameters

Return Value

mixed

Exceptions

AccessDeniedHttpException

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

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

Parameters

string	$key
ReflectionParameter	$parameter

Return Value

bool

protected array formatChannels(array $channels)

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

Parameters

array

$channels

Return Value

array

protected BindingRegistrar binder()

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

Return Value

BindingRegistrar

protected callable normalizeChannelHandlerToCallable(mixed $callback)

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

Parameters

mixed

$callback

Return Value

callable

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

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

Parameters

Request	$request
string	$channel

Return Value

mixed

protected array retrieveChannelOptions(string $channel)

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

Parameters

string

$channel

Return Value

array

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

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

Parameters

string	$channel
string	$pattern

Return Value

bool

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