Spec-Zone.ru › Laravel 5.8

LogBroadcaster

class LogBroadcaster extends Broadcaster (View source)

Свойства

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

Методы

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

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

из Broadcaster
mixed retrieveUser(Request $request, string $channel)

Получение аутентифицированного пользователя с помощью настроенной охраны (если таковая имеется).

из Broadcaster
array retrieveChannelOptions(string $channel)

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

из Broadcaster
bool channelNameMatchesPattern(string $channel, string $pattern)

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

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

Регистрация аутентификатора канала.

Параметры

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

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

Параметры

mixed $callback

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

callable|Closure

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/5.8/Illuminate/Broadcasting/Broadcasters/LogBroadcaster.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API