Spec-Zone.ru › Laravel 10

LogBroadcaster

class LogBroadcaster extends Broadcaster (View source)

Свойства

protected Closure|null $authenticatedUserCallback

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

from Broadcaster
protected array $channels

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

from Broadcaster
protected array $channelOptions

Зарегистрированные параметры каналов.

from Broadcaster
protected BindingRegistrar $bindingRegistrar

Экземпляр регистратора привязок.

from Broadcaster
protected LoggerInterface $logger

Реализация логгера.

Методы

array|null resolveAuthenticatedUser(Request $request)

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

из Broadcaster
void resolveAuthenticatedUserUsing(Closure $callback)

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

из Broadcaster
$this channel(HasBroadcastChannel|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 normalizeChannelHandlerToCallable(mixed $callback)

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

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

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

из Broadcaster
array retrieveChannelOptions(string $channel)

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

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

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

из Broadcaster
Collection getChannels()

Получить все зарегистрированные каналы.

из Broadcaster
void __construct(LoggerInterface $logger)

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

mixed auth(Request $request)

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

mixed validAuthenticationResponse(Request $request, mixed $result)

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

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

Разослать данное событие.

Details

array|null resolveAuthenticatedUser(Request $request)

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

См.: https://pusher.com/docs/channels/library_auth_reference/auth-signatures/#user-authentication.

Parameters

Request $request

Return Value

array|null

void resolveAuthenticatedUserUsing(Closure $callback)

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

См.: https://pusher.com/docs/channels/library_auth_reference/auth-signatures/#user-authentication.

Parameters

Closure $callback

Return Value

void

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

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

Параметры

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

Коллекция getChannels()

Получить все зарегистрированные каналы.

Значение возврата

Коллекция

void __construct(LoggerInterface $logger)

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

Параметры

LoggerInterface $logger

Значение возврата

void

mixed auth(Запрос $request)

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

Параметры

Запрос $request

Значение возврата

mixed

mixed validAuthenticationResponse(Запрос $request, mixed $result)

Возвратить допустимый ответ проверки подлинности.

Параметры

Запрос $request
mixed $result

Значение возврата

mixed

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

Отправить заданное событие.

Параметры

array $channels
string $event
array $payload

Значение возврата

void

Исключения

BroadcastException

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

Spec-Zone.ru

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