PusherBroadcaster

class PusherBroadcaster extends Broadcaster (View source)

Свойства

protected array	$channels	Зарегистрированные аутентификаторы каналов.	из Broadcaster
protected BindingRegistrar	$bindingRegistrar	Экземпляр регистратора привязки.	из Broadcaster
protected Pusher	$pusher	Экземпляр SDK Pusher.

Методы

$this

channel(string $channel, callable|string $callback)

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

из 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

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)

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

Параметры

string	$channel
callable\|string	$callback

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

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

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

Параметры

mixed

$callback

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

callable|Closure

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

Pusher getPusher()

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

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

Pusher

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