Spec-Zone.ru › Laravel 5.7

RedisBroadcaster

class RedisBroadcaster extends Broadcaster (View source)

Свойства

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

Методы

$this channel(string $channel, callable|string $callback)

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

из 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)

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

из Broadcaster
BindingRegistrar binder()

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

из Broadcaster
callable|Closure normalizeChannelHandlerToCallable(mixed $callback)

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

из Broadcaster
void __construct(Factory $redis, string|null $connection = null)

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

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)

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

Параметры

string $channel
callable|string $callback

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

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

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

Параметры

mixed $callback

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

callable|Closure

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.7/Illuminate/Broadcasting/Broadcasters/RedisBroadcaster.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API