RedisBroadcaster
class RedisBroadcaster extends Broadcaster (View source)
Трейты
| UsePusherChannelConventions |
Свойства
| 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)
Определить полезную нагрузку аутентифицированного пользователя для входящего запроса соединения. | из Broadcaster |
| void | resolveAuthenticatedUserUsing(Closure $callback)
Зарегистрировать обратный вызов извлечения пользователя, используемый для аутентификации подключений. | из Broadcaster |
| $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 |
| Collection | getChannels()
Получить все зарегистрированные каналы. | из Broadcaster |
| bool | isGuardedChannel(string $channel)
Возвращает true, если канал защищен аутентификацией. | из UsePusherChannelConventions |
| string | normalizeChannelName(string $channel)
Удалить префикс из имени канала. | из 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.
void resolveAuthenticatedUserUsing(Closure $callback)
Зарегистрировать обратный вызов для получения пользователя, используемый для аутентификации подключений.
См.: https://pusher.com/docs/channels/library_auth_reference/auth-signatures/#user-authentication.
$this channel(HasBroadcastChannel|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 callable normalizeChannelHandlerToCallable(mixed $callback)
Нормализовать заданный обратный вызов в вызываемый объект.
protected mixed retrieveUser(Request $request, string $channel)
Получить аутентифицированного пользователя, используя настроенного охранника (если таковой имеется).
protected array retrieveChannelOptions(string $channel)
Получить параметры для определённого канала.
protected bool channelNameMatchesPattern(string $channel, string $pattern)
Проверить, соответствует ли имя канала из запроса шаблону зарегистрированных каналов.
Collection getChannels()
Получить все зарегистрированные каналы.
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/11.x/Illuminate/Broadcasting/Broadcasters/RedisBroadcaster.html
