Spec-Zone.ru › Laravel 9

Вещатель

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

Свойства

protected Closure|null $authenticatedUserCallback

Обратный вызов для получения данных об аутентифицированном пользователе.

protected array $channels

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

protected array $channelOptions

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

protected BindingRegistrar $bindingRegistrar

Экземпляр регистратора связей.

Методы

array|null resolveAuthenticatedUser(Запрос $request)

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

void resolveAuthenticatedUserUsing(Closure $callback)

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

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

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

mixed verifyUserCanAccessChannel(Запрос $request, string $channel)

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

array extractAuthParameters(string $pattern, string $channel, callable|string $callback)

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

ReflectionParameter[] extractParameters(callable|string $callback)

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

ReflectionParameter[] extractParametersFromClass(string $callback)

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

array extractChannelKeys(string $pattern, string $channel)

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

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

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

mixed resolveExplicitBindingIfPossible(string $key, mixed $value)

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

mixed resolveImplicitBindingIfPossible(string $key, mixed $value, array $callbackParameters)

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

bool isImplicitlyBindable(string $key, ReflectionParameter $parameter)

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

array formatChannels(array $channels)

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

BindingRegistrar binder()

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

callable normalizeChannelHandlerToCallable(mixed $callback)

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

mixed retrieveUser(Запрос $request, string $channel)

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

array retrieveChannelOptions(string $channel)

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

bool channelNameMatchesPattern(string $channel, string $pattern)

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

Подробности

array|null resolveAuthenticatedUser(Запрос $request)

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

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

Параметры

Запрос $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, string $channel)

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

Параметры

Запрос $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)

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

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

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

Spec-Zone.ru

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