AnonymousEvent

class AnonymousEvent implements ShouldBroadcast (View source)

Свойства

protected array	$broadcastConnection	Подключение к броадкастеру, используемое для трансляции события.	из InteractsWithBroadcasting
string\|null	$socket	Идентификатор сокета пользователя, который поднял событие.	из InteractsWithSockets
protected	$connection	Подключение, на котором должно транслироваться событие.
protected	$name	Имя, под которым должно транслироваться событие.
protected	$payload	Payload, с которым должно транслироваться событие.
protected	$includeCurrentUser	Включать ли текущего пользователя в трансляцию.
protected	$shouldBroadcastNow	Указывает, должно ли событие транслироваться синхронно.

Свойства

Dispatchable

InteractsWithBroadcasting

InteractsWithSockets

Методы

static mixed

dispatch()

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

from Dispatchable

static mixed

dispatchIf(bool $boolean, mixed ...$arguments)

Отправить событие с заданными аргументами, если заданное условие истинно.

from Dispatchable

static mixed

dispatchUnless(bool $boolean, mixed ...$arguments)

Отправить событие с заданными аргументами, если заданное условие ложно.

from Dispatchable

static PendingBroadcast

broadcast()

Отправить событие с заданными аргументами на трансляцию.

from Dispatchable

$this

broadcastVia(array|string|null $connection = null)

Отправить событие на трансляцию с использованием конкретного распространителя.

from InteractsWithBroadcasting

array

broadcastConnections()

Получить подключения распространителя, на которые должно транслироваться событие.

from InteractsWithBroadcasting

$this

dontBroadcastToCurrentUser()

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

from InteractsWithSockets

$this

broadcastToEveryone()

Отправить событие на трансляцию всем.

from InteractsWithSockets

void

__construct(Channel|array|string $channels)

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

AnonymousEvent

via(string $connection)

Указать подключение для трансляции события.

AnonymousEvent

as(string $name)

Указать имя для трансляции события.

AnonymousEvent

with(Arrayable|array $payload)

Указать полезную нагрузку для трансляции события.

AnonymousEvent

toOthers()

Отправить событие на трансляцию всем, кроме текущего пользователя.

void

sendNow()

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

void

send()

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

string

broadcastAs()

Получить имя для трансляции события.

array

broadcastWith()

Получить полезную нагрузку для трансляции события.

Channel|Channel[]|string[]|string

broadcastOn()

Получить каналы для трансляции события.

bool

shouldBroadcastNow()

Определить, должно ли событие транслироваться синхронно.

Подробности

static mixed dispatch()

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

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

mixed

static mixed dispatchIf(bool $boolean, mixed ...$arguments)

Отправить событие с заданными аргументами, если заданное условие истинно.

Параметры

bool	$boolean
mixed	...$arguments

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

mixed

static mixed dispatchUnless(bool $boolean, mixed ...$arguments)

Отправить событие с заданными аргументами, если заданное условие ложно.

Параметры

bool	$boolean
mixed	...$arguments

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

mixed

static PendingBroadcast broadcast()

Отправить событие на трансляцию с заданными аргументами.

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

PendingBroadcast

$this broadcastVia(array|string|null $connection = null)

Отправить событие на трансляцию с использованием конкретного распространителя.

Параметры

array|string|null

$connection

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

$this

массив broadcastConnections()

Получить подключения к передатчику, на которых должно быть отправлено событие.

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

массив

$this dontBroadcastToCurrentUser()

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

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

$this

$this broadcastToEveryone()

Отправить событие всем.

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

$this

void __construct(Channel|array|string $channels)

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

Параметры

Channel|array|string

$channels

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

void

AnonymousEvent via(string $connection)

Установить подключение, на котором должно быть отправлено событие.

Параметры

string

$connection

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

AnonymousEvent

AnonymousEvent as(string $name)

Установить имя, под которым должно быть отправлено событие.

Параметры

string

$name

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

AnonymousEvent

AnonymousEvent with(Arrayable|array $payload)

Установить полезную нагрузку, с которой должно быть отправлено событие.

Параметры

Arrayable|array

$payload

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

AnonymousEvent

AnonymousEvent toOthers()

Отправить событие всем, кроме текущего пользователя.

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

AnonymousEvent

void sendNow()

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

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

void

void send()

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

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

void

строка broadcastAs()

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

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

строка

массив broadcastWith()

Получить полезную нагрузку, с которой должно быть отправлено событие.

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

массив

Канал|Канал[]|строка[]|строка broadcastOn()

Получить каналы, на которых должно быть отправлено событие.

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

Канал|Канал[]|строка[]|строка

логическое значение shouldBroadcastNow()

Определить, должно ли событие быть отправлено синхронно.

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

логическое значение

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