Spec-Zone.ru › Laravel 11

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
Collection getChannels()

Получение всех зарегистрированных каналов.

из 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.

Parameters

Request $request

Return Value

array|null

void resolveAuthenticatedUserUsing(Closure $callback)

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

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

Parameters

Closure $callback

Return Value

void

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

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

Parameters

HasBroadcastChannel|string $channel
callable|string $callback
array $options

Return Value

$this

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

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

Parameters

Request $request
string $channel

Return Value

mixed

Exceptions

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

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

Parameters

mixed $callback

Return Value

callable

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

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

Параметры

Request $request
строка $channel

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

mixed

protected array retrieveChannelOptions(string $channel)

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

Параметры

строка $channel

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

массив

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

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

Параметры

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

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

bool

Collection getChannels()

Получить все зарегистрированные каналы.

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

Collection

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

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

Параметры

массив $channels
строка $event
массив $payload

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

void

Исключения

BroadcastException

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

Spec-Zone.ru

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