AblyBroadcaster

class AblyBroadcaster extends Broadcaster (View source)

Свойства

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

Методы

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)

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

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

void

__construct(AblyRest $ably)

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

mixed

auth(Request $request)

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

mixed

validAuthenticationResponse(Request $request, mixed $result)

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

string

generateAblySignature(string $channelName, string $socketId, array|null $userData = null)

Сгенерировать подпись, необходимую для заголовков аутентификации Ably.

void

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

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

Message

buildAblyMessage(string $event, array $payload = [])

Создать объект сообщения Ably для отправки.

bool

isGuardedChannel(string $channel)

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

string

normalizeChannelName(string $channel)

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

string

getPublicToken()

Получить значение публичного токена из ключа Ably.

string

getPrivateToken()

Получить значение приватного токена из ключа Ably.

AblyRest

getAbly()

Получить экземпляр базового SDK Ably.

void

setAbly(AblyRest $ably)

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

Подробности

массив|null resolveAuthenticatedUser(Запрос $request)

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

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

Параметры

Запрос

$request

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

массив|null

пустое значение resolveAuthenticatedUserUsing(Closure $callback)

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

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

Параметры

Closure

$callback

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

пустое значение

$this channel(HasBroadcastChannel|строка $channel, вызываемая функция|строка $callback, массив $options = [])

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

Параметры

HasBroadcastChannel\|строка	$channel
вызываемая функция\|строка	$callback
массив	$options

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

$this

protected смешанный тип verifyUserCanAccessChannel(Запрос $request, строка $channel)

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

Параметры

Запрос	$request
строка	$channel

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

смешанный тип

Исключения

AccessDeniedHttpException

protected массив extractAuthParameters(строка $pattern, строка $channel, вызываемая функция|строка $callback)

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

Параметры

строка	$pattern
строка	$channel
вызываемая функция\|строка	$callback

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

массив

protected ReflectionParameter[] extractParameters(вызываемая функция|строка $callback)

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

Параметры

вызываемая функция|строка

$callback

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

ReflectionParameter[]

Исключения

Исключение

protected ReflectionParameter[] extractParametersFromClass(строка $callback)

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

Параметры

строка

$callback

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

ReflectionParameter[]

Исключения

Исключение

protected массив extractChannelKeys(строка $pattern, строка $channel)

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

Параметры

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

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

массив

protected смешанный тип resolveBinding(строка $key, строка $value, массив $callbackParameters)

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

Параметры

строка	$key
строка	$value
массив	$callbackParameters

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

смешанный тип

protected смешанный тип resolveExplicitBindingIfPossible(строка $key, смешанный тип $value)

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

Параметры

строка	$key
смешанный тип	$value

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

смешанный тип

protected смешанный тип resolveImplicitBindingIfPossible(строка $key, смешанный тип $value, массив $callbackParameters)

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

Параметры

строка	$key
смешанный тип	$value
массив	$callbackParameters

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

смешанный тип

Исключения

AccessDeniedHttpException

protected логический тип isImplicitlyBindable(строка $key, ReflectionParameter $parameter)

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

Параметры

строка	$key
ReflectionParameter	$parameter

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

логический тип

protected массив formatChannels(массив $channels)

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

Параметры

массив

$channels

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

массив

protected BindingRegistrar binder()

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

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

BindingRegistrar

protected вызываемая функция normalizeChannelHandlerToCallable(смешанный тип $callback)

Нормализовать заданный обратный вызов в вызываемую функцию.

Параметры

смешанный тип

$callback

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

вызываемая функция

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

Collection getChannels()

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

Return Value

Collection

void __construct(AblyRest $ably)

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

Parameters

AblyRest

$ably

Return Value

void

mixed auth(Request $request)

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

Parameters

Request

$request

Return Value

mixed

Exceptions

AccessDeniedHttpException

mixed validAuthenticationResponse(Request $request, mixed $result)

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

Parameters

Request	$request
mixed	$result

Return Value

mixed

string generateAblySignature(string $channelName, string $socketId, array|null $userData = null)

Сгенерировать подпись, необходимую для заголовков аутентификации Ably.

Parameters

string	$channelName
string	$socketId
array\|null	$userData

Return Value

string

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

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

Parameters

array	$channels
string	$event
array	$payload

Return Value

void

Exceptions

BroadcastException

protected Message buildAblyMessage(string $event, array $payload = [])

Создать объект сообщения Ably для отправки.

Parameters

string	$event
array	$payload

Return Value

Message

bool isGuardedChannel(string $channel)

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

Parameters

string

$channel

Return Value

bool

string normalizeChannelName(string $channel)

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

Parameters

string

$channel

Return Value

string

protected string getPublicToken()

Получить значение public токена из ключа Ably.

Return Value

string

protected string getPrivateToken()

Получить значение private токена из ключа Ably.

Return Value

string

AblyRest getAbly()

Получить базовый экземпляр SDK Ably.

Return Value

AblyRest

void setAbly(AblyRest $ably)

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

Parameters

AblyRest

$ably

Return Value

void

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