Spec-Zone.ru › Laravel 7

NullBroadcaster

class NullBroadcaster extends Broadcaster (View source)

Свойства

protected массив $channels

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

из Broadcaster
protected массив $channelOptions

Зарегистрированные параметры каналов.

из Broadcaster
protected BindingRegistrar $bindingRegistrar

Экземпляр регистрирующего привязки.

из Broadcaster

Методы

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

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

из Broadcaster
смешанный verifyUserCanAccessChannel(Request $request, строка $channel)

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

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

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

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

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

из Broadcaster
ReflectionParameter[] extractParametersFromClass(строка $callback)

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

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

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

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

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

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

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

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

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

из Broadcaster
логическое isImplicitlyBindable(строка $key, ReflectionParameter $parameter)

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

из Broadcaster
массив formatChannels(массив $channels)

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

из Broadcaster
BindingRegistrar binder()

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

из Broadcaster
вызываемый normalizeChannelHandlerToCallable(смешанный $callback)

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

из Broadcaster
смешанный retrieveUser(Request $request, строка $channel)

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

из Broadcaster
массив retrieveChannelOptions(строка $channel)

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

из Broadcaster
логическое channelNameMatchesPattern(строка $channel, строка $pattern)

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

из Broadcaster
смешанный auth(Request $request)

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

смешанный validAuthenticationResponse(Request $request, смешанный $result)

Возвращает допустимый ответ аутентификации.

пусто broadcast(массив $channels, строка $event, массив $payload = [])

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

Подробности

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

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

Параметры

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

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

$this

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

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

Параметры

Request $request
строка $channel

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

смешанный

Исключения

AccessDeniedHttpException

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

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

Параметры

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

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

массив
END_OF_DOCUMENT_MARKER

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

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

Parameters

callable|string $callback

Return Value

ReflectionParameter[]

Exceptions

Exception

protected ReflectionParameter[] extractParametersFromClass(string $callback)

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

Parameters

string $callback

Return Value

ReflectionParameter[]

Exceptions

Exception

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

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

Parameters

string $pattern
string $channel

Return Value

array

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

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

Parameters

string $key
string $value
array $callbackParameters

Return Value

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

mixed auth(Request $request)

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

Parameters

Request $request

Return Value

mixed

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

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

Spec-Zone.ru

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