Spec-Zone.ru › Laravel 5.8

NullBroadcaster

class NullBroadcaster extends Broadcaster (View source)

Свойства

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

Методы

$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)

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

из Broadcaster
BindingRegistrar binder()

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

из Broadcaster
callable|Closure normalizeChannelHandlerToCallable(mixed $callback)

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

из Broadcaster
mixed retrieveUser(Request $request, string $channel)

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

из Broadcaster
array retrieveChannelOptions(string $channel)

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

из Broadcaster
bool channelNameMatchesPattern(string $channel, string $pattern)

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

из Broadcaster
mixed auth(Request $request)

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

mixed validAuthenticationResponse(Request $request, mixed $result)

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

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

Отправить событие.

Подробное описание

$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)

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

Parameters

string $pattern
string $channel
callable|string $callback

Return Value

array

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|Closure normalizeChannelHandlerToCallable(mixed $callback)

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

Parameters

mixed $callback

Return Value

callable|Closure

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 = [])

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

Параметры

array $channels
string $event
array $payload

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

void

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

Spec-Zone.ru

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