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(HasBroadcastChannel|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)

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

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

Транслировать заданное событие.

bool

pusherServerIsVersionFiveOrGreater()

Определить, является ли сервер Pusher PHP версии 5.0 или выше.

Pusher

getPusher()

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

void

setPusher(Pusher $pusher)

Установить экземпляр Pusher SDK.

Подробности

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

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

Parameters

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

Return Value

$this

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

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

Parameters

Request	$request
string	$channel

Return Value

mixed

Exceptions

AccessDeniedHttpException

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

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

Parameters

string	$pattern
string	$channel
callable\|string	$callback

Return Value

array

protected ReflectionParameter[] extractParameters(callable|string $callback)

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

Parameters

callable|string

$callback

Return Value

ReflectionParameter[]

Exceptions

Exception

protected ReflectionParameter[] extractParametersFromClass(string $callback)

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

Parameters

string

$callback

Return Value

ReflectionParameter[]

Exceptions

Exception

protected array extractChannelKeys(string $pattern, string $channel)

Извлечь ключи канала из входящего имени канала.

Parameters

string	$pattern
string	$channel

Return Value

array

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

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

Parameters

string	$key
string	$value
array	$callbackParameters

Return Value

mixed

protected mixed resolveExplicitBindingIfPossible(string $key, mixed $value)

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

Parameters

string	$key
mixed	$value

Return Value

mixed

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

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

Parameters

string	$key
mixed	$value
array	$callbackParameters

Return Value

mixed

Exceptions

AccessDeniedHttpException

protected bool isImplicitlyBindable(string $key, ReflectionParameter $parameter)

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

Parameters

string	$key
ReflectionParameter	$parameter

Return Value

bool

protected array formatChannels(array $channels)

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

Parameters

array

$channels

Return Value

array

protected BindingRegistrar binder()

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

Return Value

BindingRegistrar

protected callable normalizeChannelHandlerToCallable(mixed $callback)

Нормализовать заданный обратный вызов в вызываемую функцию.

Parameters

mixed

$callback

Return Value

callable

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

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

Parameters

Request	$request
string	$channel

Return Value

mixed

protected array retrieveChannelOptions(string $channel)

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

Parameters

string

$channel

Return Value

array

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

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

Parameters

string	$channel
string	$pattern

Return Value

bool

bool isGuardedChannel(string $channel)

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

Parameters

string

$channel

Return Value

bool

string normalizeChannelName(string $channel)

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

Parameters

string

$channel

Return Value

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

protected bool pusherServerIsVersionFiveOrGreater()

Определить, является ли сервер Pusher PHP версии 5.0 или выше.

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

bool

Pusher getPusher()

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

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

Pusher

void setPusher(Pusher $pusher)

Установить экземпляр SDK Pusher.

Параметры

Pusher

$pusher

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

void

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