Spec-Zone.ru › Laravel 10

Broadcaster

абстрактный класс Broadcaster реализует Broadcaster (View source)

Свойства

protected Closure|null $authenticatedUserCallback

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

protected array $channels

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

protected array $channelOptions

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

protected BindingRegistrar $bindingRegistrar

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

Методы

array|null resolveAuthenticatedUser(Request $request)

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

void resolveAuthenticatedUserUsing(Closure $callback)

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

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

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

mixed verifyUserCanAccessChannel(Request $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)

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

Подробности

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
END_OF_DOCUMENT_MARKER

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

Collection getChannels()

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

Значение возврата

Collection

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

Spec-Zone.ru

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