RedisBroadcaster
класс RedisBroadcaster расширяет Broadcaster (View source)
Свойства
| UsePusherChannelConventions |
Свойства
| protected массив | $channels | Зарегистрированные аутентификаторы каналов. | из Broadcaster |
| protected массив | $channelOptions | Зарегистрированные параметры каналов. | из Broadcaster |
| protected BindingRegistrar | $bindingRegistrar | Экземпляр регистратора связей. | из Broadcaster |
| protected Factory | $redis | Экземпляр Redis. | |
| protected строка | $connection | Подключение Redis для трансляции. | |
| protected строка | $prefix | Префикс ключа Redis. |
Методы
| $this | channel(строка $channel, вызываемый объект|строка $callback, массив $options = []) Зарегистрировать аутентификатор канала. | из Broadcaster |
| смешанный | verifyUserCanAccessChannel(Request $request, строка $channel) Аутентифицировать входящий запрос для указанного канала. | из Broadcaster |
| массив | extractAuthParameters(строка $pattern, строка $channel, вызываемый объект|строка $callback) Извлечь параметры из заданного шаблона и канала. | из Broadcaster |
| ReflectionParameter[] | extractParameters(вызываемый объект|строка $callback) Извлекает параметры из переданного пользователем обработчика аутентификации канала. | из Broadcaster |
| ReflectionParameter[] | extractParametersFromClass(строка $callback) Извлекает параметры из метода "join" канала класса. | из Broadcaster |
| массив | extractChannelKeys(строка $pattern, строка $channel) Извлечь ключи канала из входящего имени канала. | из Broadcaster |
| смешанный | resolveBinding(строка $key, строка $value, массив $callbackParameters) Разрешить заданную привязку параметра. | из Broadcaster |
| смешанный | resolveExplicitBindingIfPossible(строка $key, смешанный $value) Разрешить явную привязку параметра, если применимо. | из Broadcaster |
| смешанный | resolveImplicitBindingIfPossible(строка $key, смешанный $value, массив $callbackParameters) Разрешить неявную привязку параметра, если применимо. | из Broadcaster |
| bool | isImplicitlyBindable(строка $key, ReflectionParameter $parameter) Определить, можно ли неявно привязать данный ключ и параметр. | из Broadcaster |
| массив | formatChannels(массив $channels) Отформатировать массив каналов в массив строк. | |
| BindingRegistrar | binder() Получить экземпляр регистратора связей моделей. | из Broadcaster |
| Closure|вызываемый объект | normalizeChannelHandlerToCallable(смешанный $callback) Нормализовать переданный обратный вызов в вызываемый объект. | из Broadcaster |
| смешанный | retrieveUser(Request $request, строка $channel) Получить аутентифицированного пользователя, используя настроенного охранника (если есть). | из Broadcaster |
| массив | retrieveChannelOptions(строка $channel) Получить параметры для определенного канала. | из Broadcaster |
| bool | channelNameMatchesPattern(строка $channel, строка $pattern) Проверить, соответствует ли имя канала шаблону из зарегистрированных каналов. | из Broadcaster |
| bool | isGuardedChannel(строка $channel) Возвращает true, если канал защищен аутентификацией. | из UsePusherChannelConventions |
| строка | normalizeChannelName(строка $channel) Удалить префикс из имени канала. | из UsePusherChannelConventions |
| void | __construct(Factory $redis, строка|null $connection = null, строка $prefix = '') Создать новый экземпляр транслятора. | |
| смешанный | auth(Request $request) Аутентифицировать входящий запрос для указанного канала. | |
| смешанный | validAuthenticationResponse(Request $request, смешанный $result) Возвратить корректный ответ об аутентификации. | |
| void | broadcast(массив $channels, строка $event, массив $payload = []) Транслировать заданное событие. | |
| строка | broadcastMultipleChannelsScript() Получить Lua скрипт для трансляции на множественные каналы. |
Подробности
$this channel(string $channel, callable|string $callback, array $options = [])
Регистрация аутентификатора канала.
protected mixed verifyUserCanAccessChannel(Request $request, string $channel)
Аутентификация входящего запроса для заданного канала.
protected array extractAuthParameters(string $pattern, string $channel, callable|string $callback)
Извлечение параметров из заданного шаблона и канала.
protected ReflectionParameter[] extractParameters(callable|string $callback)
Извлечение параметров из переданного пользователем обработчика аутентификации канала.
protected ReflectionParameter[] extractParametersFromClass(string $callback)
Извлечение параметров из метода "join" канала класса.
protected array extractChannelKeys(string $pattern, string $channel)
Извлечение ключей канала из имени входящего канала.
protected mixed resolveBinding(string $key, string $value, array $callbackParameters)
Разрешение привязки заданного параметра.
protected mixed resolveExplicitBindingIfPossible(string $key, mixed $value)
Разрешение явной привязки параметра, если применимо.
protected mixed resolveImplicitBindingIfPossible(string $key, mixed $value, array $callbackParameters)
Разрешение неявной привязки параметра, если применимо.
protected bool isImplicitlyBindable(string $key, ReflectionParameter $parameter)
Определение возможности неявной привязки заданного ключа и параметра.
protected array formatChannels(array $channels)
Форматирование массива каналов в массив строк.
protected BindingRegistrar binder()
Получение экземпляра регистратора привязок моделей.
protected Closure|callable normalizeChannelHandlerToCallable(mixed $callback)
Нормализация переданного обработчика в вызываемый объект.
protected mixed retrieveUser(Request $request, string $channel)
Получение аутентифицированного пользователя с использованием настроенного охранника (если есть).
protected array retrieveChannelOptions(string $channel)
Получение опций для определенного канала.
protected bool channelNameMatchesPattern(string $channel, string $pattern)
Проверка соответствия имени канала из запроса шаблону зарегистрированных каналов.
bool isGuardedChannel(string $channel)
Возвращает true, если канал защищен аутентификацией.
string normalizeChannelName(string $channel)
Удаляет префикс из имени канала.
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 = [])
Распространяет заданное событие.
protected string broadcastMultipleChannelsScript()
Получить Lua скрипт для распространения на несколько каналов.
ARGV[1] - Данные ARGV[2...] - Каналы
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/6.x/Illuminate/Broadcasting/Broadcasters/RedisBroadcaster.html
