Вещатель

абстрактный класс Вещатель реализует Вещатель (Просмотреть исходный код)

Свойства

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

Методы

$this

channel(строка $channel, вызываемый|строка $callback, массив $options = [])

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

смешанный

verifyUserCanAccessChannel(Запрос $request, строка $channel)

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

массив

extractAuthParameters(строка $pattern, строка $channel, вызываемый|строка $callback)

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

ReflectionParameter[]

extractParameters(вызываемый|строка $callback)

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

ReflectionParameter[]

extractParametersFromClass(строка $callback)

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

массив

extractChannelKeys(строка $pattern, строка $channel)

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

смешанный

resolveBinding(строка $key, строка $value, массив $callbackParameters)

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

смешанный

resolveExplicitBindingIfPossible(строка $key, смешанный $value)

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

смешанный

resolveImplicitBindingIfPossible(строка $key, смешанный $value, массив $callbackParameters)

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

булево

isImplicitlyBindable(строка $key, ReflectionParameter $parameter)

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

массив

formatChannels(массив $channels)

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

BindingRegistrar

binder()

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

вызываемый

normalizeChannelHandlerToCallable(смешанный $callback)

Нормализация переданного обратного вызова в вызываемый.

смешанный

retrieveUser(Запрос $request, строка $channel)

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

массив

retrieveChannelOptions(строка $channel)

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

булево

channelNameMatchesPattern(строка $channel, строка $pattern)

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

Подробности

$this channel(строка $channel, вызываемый|строка $callback, массив $options = [])

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

Параметры

строка	$channel
вызываемый\|строка	$callback
массив	$options

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

$this

protected смешанный verifyUserCanAccessChannel(Запрос $request, строка $channel)

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

Параметры

Запрос	$request
строка	$channel

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

смешанный

Исключения

AccessDeniedHttpException

protected массив extractAuthParameters(строка $pattern, строка $channel, вызываемый|строка $callback)

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

Параметры

строка	$pattern
строка	$channel
вызываемый\|строка	$callback

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

массив

protected ReflectionParameter[] extractParameters(вызываемый|строка $callback)

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

Параметры

вызываемый|строка

$callback

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

ReflectionParameter[]

Исключения

Исключение

protected ReflectionParameter[] extractParametersFromClass(строка $callback)

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

Параметры

строка

$callback

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

ReflectionParameter[]

Исключения

Исключение

protected массив extractChannelKeys(строка $pattern, строка $channel)

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

Параметры

строка	$pattern
строка	$channel

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

массив

protected смешанный resolveBinding(строка $key, строка $value, массив $callbackParameters)

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

Параметры

строка	$key
строка	$value
массив	$callbackParameters

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

смешанный

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/7.x/Illuminate/Broadcasting/Broadcasters/Broadcaster.html