PusherBroadcaster

класс PusherBroadcaster расширяет Broadcaster (Просмотреть исходный код)

Трейты

Свойства

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

Методы

array|null

resolveAuthenticatedUser(Request $request)

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

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

bool

isGuardedChannel(string $channel)

Возвращает true, если канал защищен аутентификацией.

из UsePusherChannelConventions

string

normalizeChannelName(string $channel)

Удалить префикс из имени канала.

из UsePusherChannelConventions

void

__construct(Pusher $pusher)

Создать новый экземпляр распространителя.

mixed

auth(Request $request)

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

mixed

validAuthenticationResponse(Request $request, mixed $result)

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

array

decodePusherResponse(Request $request, mixed $response)

Декодировать полученный ответ Pusher.

void

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

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

Pusher

getPusher()

Получить экземпляр SDK Pusher.

void

setPusher(Pusher $pusher)

Установить экземпляр SDK Pusher.

Подробности

array|null resolveAuthenticatedUser(Request $request)

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

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

Параметры

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, string $channel)

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

Параметры

Запрос	$request
string	$channel

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

mixed

protected array retrieveChannelOptions(string $channel)

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

Параметры

string

$channel

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

array

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

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

Параметры

string	$channel
string	$pattern

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

bool

bool isGuardedChannel(string $channel)

Возвращает true, если канал защищен аутентификацией.

Параметры

string

$channel

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

bool

string normalizeChannelName(string $channel)

Удалить префикс из имени канала.

Параметры

string

$channel

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

string

void __construct(Pusher $pusher)

Создать новый экземпляр брокеров.

Параметры

Pusher

$pusher

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

void

mixed auth(Запрос $request)

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

Параметры

Запрос

$request

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

mixed

Исключения

AccessDeniedHttpException

mixed validAuthenticationResponse(Запрос $request, mixed $result)

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

Параметры

Запрос	$request
mixed	$result

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

mixed

protected array decodePusherResponse(Запрос $request, mixed $response)

Декодировать полученный ответ от Pusher.

Параметры

Запрос	$request
mixed	$response

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

array

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

Рассылать заданное событие.

Параметры

array	$channels
string	$event
array	$payload

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

void

Исключения

BroadcastException

Pusher getPusher()

Получить экземпляр SDK Pusher.

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

Pusher

void setPusher(Pusher $pusher)

Установить экземпляр SDK Pusher.

Параметры

Pusher

$pusher

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

void

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