PusherBroadcaster

class PusherBroadcaster extends Broadcaster (View source)

Свойства

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

Closure|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(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 = [])

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

Параметры

string	$channel
callable\|string	$callback
array	$options

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

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

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

Параметры

mixed

$callback

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

Closure|callable

protected mixed retrieveUser(Request $request, string $channel)

Получить аутентифицированного пользователя, используя настроенный страж (если есть).

Параметры

Request	$request
string	$channel

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

mixed

protected array retrieveChannelOptions(string $channel)

Получить параметры для определенного канала.

Параметры

string

$channel

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

array

protected bool channelNameMatchesPattern(string $channel, string $pattern)

Проверить, соответствует ли имя канала шаблону из зарегистрированных каналов.

Параметры

string	$channel
string	$pattern

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

bool

bool isGuardedChannel(string $channel)

Возвращает true, если канал защищен аутентификацией.

Параметры

string

$channel

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

bool

string normalizeChannelName(string $channel)

Удаляет префикс из имени канала.

Параметры

string

$channel

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

string

void __construct(Pusher $pusher)

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

Параметры

Pusher

$pusher

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

void

mixed auth(Request $request)

Аутентифицирует входящий запрос для заданного канала.

Параметры

Request

$request

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

mixed

Исключения

AccessDeniedHttpException

mixed validAuthenticationResponse(Request $request, mixed $result)

Возвращает правильный ответ аутентификации.

Параметры

Request	$request
mixed	$result

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

mixed

protected array decodePusherResponse(Request $request, mixed $response)

Декодирует полученный ответ Pusher.

Параметры

Request	$request
mixed	$response

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

array

void broadcast(array $channels, string $event, array $payload = [])

Отправляет заданное событие.

Параметры

array	$channels
string	$event
array	$payload

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

void

Исключения

BroadcastException

Pusher getPusher()

Получить экземпляр SDK Pusher.

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

Pusher

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/6.x/Illuminate/Broadcasting/Broadcasters/PusherBroadcaster.html