PusherBroadcaster

class PusherBroadcaster extends Broadcaster (View source)

Свойства

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

Методы

$this

channel(string $channel, callable|string $callback, array $options = [])

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

from Broadcaster

mixed

verifyUserCanAccessChannel(Request $request, string $channel)

Проверить возможность доступа пользователя к каналу.

from Broadcaster

array

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

Извлечь параметры из шаблона и канала.

from Broadcaster

ReflectionParameter[]

extractParameters(callable|string $callback)

Извлечь параметры из переданной функции аутентификации канала.

from Broadcaster

ReflectionParameter[]

extractParametersFromClass(string $callback)

Извлечь параметры из метода "join" класса канала.

from Broadcaster

array

extractChannelKeys(string $pattern, string $channel)

Извлечь ключи канала из имени канала.

from Broadcaster

mixed

resolveBinding(string $key, string $value, array $callbackParameters)

Разрешить привязку заданного параметра.

from Broadcaster

mixed

resolveExplicitBindingIfPossible(string $key, mixed $value)

Разрешить явную привязку параметра, если применимо.

from Broadcaster

mixed

resolveImplicitBindingIfPossible(string $key, mixed $value, array $callbackParameters)

Разрешить неявную привязку параметра, если применимо.

from Broadcaster

bool

isImplicitlyBindable(string $key, ReflectionParameter $parameter)

Определить, можно ли неявно привязать данный ключ и параметр.

from Broadcaster

array

formatChannels(array $channels)

Форматировать массив каналов в массив строк.

from Broadcaster

BindingRegistrar

binder()

Получить экземпляр регистратора привязок моделей.

from Broadcaster

callable

normalizeChannelHandlerToCallable(mixed $callback)

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

from Broadcaster

mixed

retrieveUser(Request $request, string $channel)

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

from Broadcaster

array

retrieveChannelOptions(string $channel)

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

from Broadcaster

bool

channelNameMatchesPattern(string $channel, string $pattern)

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

from Broadcaster

bool

isGuardedChannel(string $channel)

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

from UsePusherChannelConventions

string

normalizeChannelName(string $channel)

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

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

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

Параметры

mixed

$callback

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

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

END_OF_DOCUMENT_MARKER

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/7.x/Illuminate/Broadcasting/Broadcasters/PusherBroadcaster.html