AblyBroadcaster

class AblyBroadcaster extends Broadcaster (View source)

Свойства

protected array	$channels	Зарегистрированные аутентификаторы каналов.	from Broadcaster
protected array	$channelOptions	Зарегистрированные параметры каналов.	from Broadcaster
protected BindingRegistrar	$bindingRegistrar	Экземпляр регистратора связей.	from Broadcaster
protected AblyRest	$ably	Экземпляр SDK AblyRest.

Методы

$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

void

__construct(AblyRest $ably)

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

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

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

Подробности

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

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

Параметры

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

void __construct(AblyRest $ably)

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

Параметры

AblyRest

$ably

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

void

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

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

Параметры

Запрос

$request

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

mixed

Исключения

AccessDeniedHttpException

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

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

Параметры

Запрос	$request
mixed	$result

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

mixed

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

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

Параметры

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

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

string

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

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

Параметры

array	$channels
string	$event
array	$payload

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

void

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

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

Параметры

string	$event
array	$payload

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

Message

bool isGuardedChannel(string $channel)

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

Параметры

string

$channel

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

bool

string normalizeChannelName(string $channel)

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

Параметры

string

$channel

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

string

protected mixed getPublicToken()

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

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

mixed

protected mixed getPrivateToken()

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

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

mixed

AblyRest getAbly()

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

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

AblyRest

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