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 |
| 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)
Проверьте, соответствует ли имя канала из запроса шаблону зарегистрированных каналов.
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/9.x/Illuminate/Broadcasting/Broadcasters/RedisBroadcaster.html
