PusherBroadcaster
класс PusherBroadcaster расширяет Broadcaster (View source)
Черты
| UsePusherChannelConventions |
Свойства
| protected array | $channels | Зарегистрированные аутентификаторы каналов. | из Broadcaster |
| protected array | $channelOptions | Зарегистрированные параметры каналов. | из Broadcaster |
| protected BindingRegistrar | $bindingRegistrar | Экземпляр регистратора привязки. | из Broadcaster |
| protected Pusher | $pusher | Экземпляр SDK Pusher. |
Методы
| $this | channel(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) Отформатировать массив каналов в массив строк. | из Broadcaster |
| BindingRegistrar | binder() Получить экземпляр регистратора привязки модели. | из Broadcaster |
| callable|Closure | 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(Pusher $pusher) Создать новый экземпляр вещателя. | |
| mixed | auth(Request $request) Аутентифицировать входящий запрос для данного канала. | |
| mixed | validAuthenticationResponse(Request $request, mixed $result) Вернуть допустимый ответ аутентификации. | |
| array | decodePusherResponse(Request $request, mixed $response) Декодировать заданный ответ Pusher. | |
| void | broadcast(array $channels, string $event, array $payload = []) Разослать заданное событие. | |
| Pusher | getPusher() Получить экземпляр SDK Pusher. |
Подробности
$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 callable|Closure 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(Pusher $pusher)
Создаёт новый экземпляр броадкастера.
mixed auth(Request $request)
Проверяет аутентификацию входящего запроса для заданного канала.
mixed validAuthenticationResponse(Request $request, mixed $result)
Возвращает корректный ответ аутентификации.
protected array decodePusherResponse(Request $request, mixed $response)
Декодирует полученный ответ Pusher.
void broadcast(array $channels, string $event, array $payload = [])
Транслирует заданное событие.
Pusher getPusher()
Получить экземпляр SDK Pusher.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.8/Illuminate/Broadcasting/Broadcasters/PusherBroadcaster.html
