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)

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

from Broadcaster

void

resolveAuthenticatedUserUsing(Closure $callback)

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

from Broadcaster

$this

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

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

from Broadcaster

mixed

verifyUserCanAccessChannel(Request $request, string $channel)

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

from Broadcaster

array

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

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

from Broadcaster

ReflectionParameter[]

extractParameters(callable|string $callback)

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

from Broadcaster

ReflectionParameter[]

extractParametersFromClass(string $callback)

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

from Broadcaster

array

extractChannelKeys(string $pattern, string $channel)

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

from Broadcaster

mixed

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

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

from Broadcaster

mixed

resolveExplicitBindingIfPossible(string $key, mixed $value)

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

from Broadcaster

mixed

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

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

from Broadcaster

bool

isImplicitlyBindable(string $key, ReflectionParameter $parameter)

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

from Broadcaster

array

formatChannels(array $channels)

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

BindingRegistrar

binder()

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

from Broadcaster

callable

normalizeChannelHandlerToCallable(mixed $callback)

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

from Broadcaster

mixed

retrieveUser(Request $request, string $channel)

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

from Broadcaster

array

retrieveChannelOptions(string $channel)

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

from Broadcaster

bool

channelNameMatchesPattern(string $channel, string $pattern)

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

from 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)

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

mixed

getPublicToken()

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

mixed

getPrivateToken()

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

AblyRest

getAbly()

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

Подробности

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

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)

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

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

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 mixed getPublicToken()

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

Return Value

mixed

protected mixed getPrivateToken()

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

Return Value

mixed

AblyRest getAbly()

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

Return Value

AblyRest

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