NullBroadcaster

класс NullBroadcaster расширяет Broadcaster (View source)

Свойства

protected Closure\|null	$authenticatedUserCallback	Обратный вызов для определения информации об аутентифицированном пользователе.	из Broadcaster
protected array	$channels	Зарегистрированные аутентификаторы каналов.	из Broadcaster
protected array	$channelOptions	Зарегистрированные параметры каналов.	из Broadcaster
protected BindingRegistrar	$bindingRegistrar	Экземпляр регистратора привязок.	из Broadcaster

Методы

array|null

resolveAuthenticatedUser(Request $request)

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

из Broadcaster

void

resolveAuthenticatedUserUsing(Closure $callback)

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

из Broadcaster

$this

channel(HasBroadcastChannel|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

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

Передача заданного события.

Подробности

array|null resolveAuthenticatedUser(Request $request)

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

См.: https://pusher.com/docs/channels/library_auth_reference/auth-signatures/#user-authentication.

Параметры

Request

$request

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

array|null

void resolveAuthenticatedUserUsing(Closure $callback)

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

См.: https://pusher.com/docs/channels/library_auth_reference/auth-signatures/#user-authentication.

Параметры

Closure

$callback

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

void

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

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

Параметры

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

mixed auth(Request $request)

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

Параметры

Request

$request

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

mixed

mixed validAuthenticationResponse(Request $request, mixed $result)

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

Параметры

Request	$request
mixed	$result

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

mixed

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

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

Параметры

array	$channels
string	$event
array	$payload

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

void

Исключения

BroadcastException

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