RedisBroadcaster

class RedisBroadcaster 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 Factory	$redis	Экземпляр Redis.
protected string\|null	$connection	Используемое соединение Redis для трансляции.
protected string	$prefix	Префикс ключа Redis.

Методы

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

bool

isGuardedChannel(string $channel)

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

from UsePusherChannelConventions

string

normalizeChannelName(string $channel)

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

from UsePusherChannelConventions

void

__construct(Factory $redis, string|null $connection = null, string $prefix = '')

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

mixed

auth(Request $request)

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

mixed

validAuthenticationResponse(Request $request, mixed $result)

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

void

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

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

string

broadcastMultipleChannelsScript()

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

Подробности

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

Collection getChannels()

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

Return Value

Collection

bool isGuardedChannel(string $channel)

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

Parameters

string

$channel

Return Value

bool

string normalizeChannelName(string $channel)

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

Parameters

string

$channel

Return Value

string

void __construct(Factory $redis, string|null $connection = null, string $prefix = '')

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

Parameters

Factory	$redis
string\|null	$connection
string	$prefix

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

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

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

Parameters

array	$channels
string	$event
array	$payload

Return Value

void

Exceptions

BroadcastException

protected string broadcastMultipleChannelsScript()

Получить сценарий Lua для распространения на несколько каналов.

ARGV[1] - Payload ARGV[2...] - Каналы

Return Value

string

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