BroadcastableModelEventOccurred

class BroadcastableModelEventOccurred implements ShouldBroadcast (View source)

Особенности

Свойства

string\|null	$socket	Идентификатор сокета пользователя, который вызвал событие.	from InteractsWithSockets
Model	$model	Экземпляр модели, соответствующий событию.
protected string	$event	Имя события (created, updated и т.д.).
protected array	$channels	Каналы, на которых должно транслироваться событие.
string	$connection	Подключение очереди, которое должно использоваться для очереди задания трансляции.
string	$queue	Очередь, которая должна использоваться для очереди задания трансляции.

Методы

$this

dontBroadcastToCurrentUser()

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

from InteractsWithSockets

$this

broadcastToEveryone()

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

from InteractsWithSockets

mixed

getSerializedPropertyValue(mixed $value)

Получить значение свойства, подготовленного для сериализации.

from SerializesAndRestoresModelIdentifiers

mixed

getRestoredPropertyValue(mixed $value)

Получить восстановленное значение свойства после десериализации.

from SerializesAndRestoresModelIdentifiers

Collection

restoreCollection(ModelIdentifier $value)

Восстановить экземпляр кэшируемого набора.

from SerializesAndRestoresModelIdentifiers

Model

restoreModel(ModelIdentifier $value)

Восстановить модель из экземпляра идентификатора модели.

from SerializesAndRestoresModelIdentifiers

Builder

getQueryForModelRestoration(Model $model, array|int $ids)

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

from SerializesAndRestoresModelIdentifiers

array

__sleep()

Подготовить экземпляр к сериализации.

from SerializesModels

void

__wakeup()

Восстановить модель после сериализации.

from SerializesModels

array

__serialize()

Подготовить значения экземпляра для сериализации.

from SerializesModels

void

__unserialize(array $values)

Восстановить модель после сериализации.

from SerializesModels

mixed

getPropertyValue(ReflectionProperty $property)

Получить значение свойства для данного свойства.

from SerializesModels

void

__construct(Model $model, string $event)

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

Channel|Channel[]|string[]|string

broadcastOn()

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

string

broadcastAs()

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

array|null

broadcastWith()

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

$this

onChannels(array $channels)

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

bool

shouldBroadcastNow()

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

string

event()

Получить имя события.

Подробности

$this dontBroadcastToCurrentUser()

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

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

$this

$this broadcastToEveryone()

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

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

$this

protected mixed getSerializedPropertyValue(mixed $value)

Получить значение свойства, подготовленного для сериализации.

Параметры

mixed

$value

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

mixed

protected mixed getRestoredPropertyValue(mixed $value)

Получить восстановленное значение свойства после десериализации.

Параметры

mixed

$value

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

mixed

protected Коллекция restoreCollection(Идентификатор модели $value)

Восстановить экземпляр коллекцию.

Параметры

Идентификатор модели

$value

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

Коллекция

Модель restoreModel(Идентификатор модели $value)

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

Параметры

Идентификатор модели

$value

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

Модель

protected Билдер getQueryForModelRestoration(Модель $model, array|int $ids)

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

Параметры

Модель	$model
array\|int	$ids

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

Билдер

Массив __sleep()

Подготовить экземпляр для сериализации.

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

Массив

Пусто __wakeup()

Восстановить модель после сериализации.

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

Пусто

Массив __serialize()

Подготовить значения экземпляра для сериализации.

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

Массив

Пусто __unserialize(array $values)

Восстановить модель после сериализации.

Параметры

Массив

$values

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

Пусто

protected смешанное getPropertyValue(ReflectionProperty $property)

Получить значение свойства для данного свойства.

Параметры

ReflectionProperty

$property

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

смешанное

Пусто __construct(Модель $model, string $event)

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

Параметры

Модель	$model
строка	$event

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

Пусто

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

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

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

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

строка broadcastAs()

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

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

строка

Массив|null broadcastWith()

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

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

Массив|null

$this onChannels(array $channels)

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

Параметры

Массив

$channels

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

$this

логический тип shouldBroadcastNow()

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

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

логический тип

строка event()

Получить имя события.

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

строка

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