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

Collection

getChannels()

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

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)

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

string

getPublicToken()

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

string

getPrivateToken()

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

AblyRest

getAbly()

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

void

setAbly(AblyRest $ably)

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

Детали

array|null resolveAuthenticatedUser(Request $request)

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

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

Parameters

Request

$request

Return Value

array|null

void resolveAuthenticatedUserUsing(Closure $callback)

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

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

Parameters

Closure

$callback

Return Value

void

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

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

Parameters

HasBroadcastChannel\|string	$channel
callable\|string	$callback
array	$options

Return Value

$this

protected mixed verifyUserCanAccessChannel(Request $request, string $channel)

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

Parameters

Request	$request
string	$channel

Return Value

mixed

Exceptions

AccessDeniedHttpException

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

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

Parameters

string	$pattern
string	$channel
callable\|string	$callback

Return Value

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

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

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

Return Value

string

protected string getPrivateToken()

Получить значение приватного токена из ключа 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/11.x/Illuminate/Broadcasting/Broadcasters/AblyBroadcaster.html