LogBroadcaster

class LogBroadcaster extends Broadcaster (View source)

Свойства

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

Методы

$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

Closure|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

void

__construct(LoggerInterface $logger)

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

mixed

auth(Request $request)

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

mixed

validAuthenticationResponse(Request $request, mixed $result)

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

void

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

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

Подробности

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

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

Parameters

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)

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

Параметры

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

void __construct(LoggerInterface $logger)

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

Параметры

LoggerInterface

$logger

Значение результата

void

mixed auth(Request $request)

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

Параметры

Request

$request

Значение результата

mixed

mixed validAuthenticationResponse(Request $request, mixed $result)

Возвращает допустимый ответ на аутентификацию.

Параметры

Request	$request
mixed	$result

Значение результата

mixed

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

Вещание заданного события.

Параметры

array	$channels
string	$event
array	$payload

Значение результата

void

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