RedisBroadcaster

class RedisBroadcaster extends Broadcaster (View source)

Свойства

protected array	$channels	Зарегистрированные аутентификаторы каналов.	from Broadcaster
protected array	$channelOptions	Зарегистрированные параметры каналов.	from Broadcaster
protected BindingRegistrar	$bindingRegistrar	Экземпляр регистратора привязок.	from Broadcaster
protected Factory	$redis	Экземпляр Redis.
protected string	$connection	Подключение Redis для вещания.

Методы

$this	channel(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) Отформатировать массив каналов в массив строк.	from Broadcaster
BindingRegistrar	binder() Получить экземпляр регистратора привязки модели.	from Broadcaster

вызываемый объект\|Closure	normalizeChannelHandlerToCallable(mixed $callback) Нормализовать переданный обратный вызов в вызываемый объект.	из Broadcaster
mixed	retrieveUser(Request $request, string $channel) Получить аутентифицированного пользователя, используя настроенную стражу (если есть).	из Broadcaster
массив	retrieveChannelOptions(string $channel) Получить параметры для определенного канала.	из Broadcaster
bool	channelNameMatchesPattern(string $channel, string $pattern) Проверить, соответствует ли имя канала из запроса шаблону зарегистрированных каналов.	из Broadcaster
bool	isGuardedChannel(string $channel) Возвращает true, если канал защищен аутентификацией.	из UsePusherChannelConventions
строка	normalizeChannelName(string $channel) Удалить префикс из имени канала.	из UsePusherChannelConventions
void	__construct(Factory $redis, string\|null $connection = null) Создать новый экземпляр Broadcaster.
mixed	auth(Request $request) Проверить аутентификацию входящего запроса для заданного канала.
mixed	validAuthenticationResponse(Request $request, mixed $result) Возвратить допустимый ответ аутентификации.
void	broadcast(array $channels, string $event, array $payload = []) Транслировать заданное событие.

Подробности

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

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

Параметры

строка	$channel
вызываемый объект\|строка	$callback
массив	$options

Значение результата

$this

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

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

Параметры

Request	$request
строка	$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)

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

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|Closure normalizeChannelHandlerToCallable(mixed $callback)

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

Parameters

mixed

$callback

Return Value

callable|Closure

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

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)

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

Параметры

Factory	$redis
string\|null	$connection

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

void

mixed auth(Request $request)

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

Параметры

Request

$request

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

mixed

Исключения

AccessDeniedHttpException

mixed validAuthenticationResponse(Request $request, mixed $result)

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

Параметры

Request	$request
mixed	$result

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

mixed

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

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

Параметры

array	$channels
string	$event
array	$payload

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

void

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