BroadcastableModelEventOccurred
class BroadcastableModelEventOccurred implements ShouldBroadcast (View source)
Особенности
| InteractsWithSockets | |
| SerializesModels | |
| SerializesAndRestoresModelIdentifiers |
Свойства
| string|null | $socket | Идентификатор сокета пользователя, вызвавшего событие. | из InteractsWithSockets |
| Model | $model | Экземпляр модели, соответствующий событию. | |
| protected string | $event | Имя события (created, updated и т.д.). | |
| protected array | $channels | Каналы, на которых должно транслироваться событие. | |
| string | $connection | Подключение очереди, которое должно использоваться для очереди задания трансляции. | |
| string | $queue | Очередь, которая должна использоваться для очереди задания трансляции. | |
| bool|null | $afterCommit | Указывает, должно ли задание быть отправлено после того, как все транзакции базы данных будут подтверждены. |
Методы
| $this | dontBroadcastToCurrentUser()
Исключить текущего пользователя из получения трансляции. | из InteractsWithSockets |
| $this | broadcastToEveryone()
Транслировать событие всем. | из InteractsWithSockets |
| mixed | getSerializedPropertyValue(mixed $value)
Получить значение свойства, подготовленное для сериализации. | из SerializesAndRestoresModelIdentifiers |
| mixed | getRestoredPropertyValue(mixed $value)
Получить восстановленное значение свойства после десериализации. | из SerializesAndRestoresModelIdentifiers |
| Collection | restoreCollection(ModelIdentifier $value)
Восстановить экземпляр коллекции, подлежащей очереди. | из SerializesAndRestoresModelIdentifiers |
| Model | restoreModel(ModelIdentifier $value)
Восстановить модель из экземпляра идентификатора модели. | из SerializesAndRestoresModelIdentifiers |
| Builder | getQueryForModelRestoration(Model $model, array|int $ids)
Получить запрос для восстановления модели. | из SerializesAndRestoresModelIdentifiers |
| array | __serialize()
Подготовить значения экземпляра для сериализации. | из SerializesModels |
| void | __unserialize(array $values)
Восстановить модель после сериализации. | из SerializesModels |
| mixed | getPropertyValue(ReflectionProperty $property)
Получить значение свойства для данного свойства. | из 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 broadcastToEveryone()
Транслировать событие всем.
protected mixed getSerializedPropertyValue(mixed $value)
Получить значение свойства, подготовленное для сериализации.
protected mixed getRestoredPropertyValue(mixed $value)
Получить восстановленное значение свойства после десериализации.
protected Коллекция restoreCollection(Идентификатор модели $value)
Восстановить экземпляр коллекций, предназначенных для очереди.
Модель restoreModel(Идентификатор модели $value)
Восстановить модель из экземпляра идентификатора модели.
protected Билдер getQueryForModelRestoration(Модель $model, array|int $ids)
Получить запрос для восстановления модели.
массив __serialize()
Подготовить значения экземпляра для сериализации.
пусто __unserialize(array $values)
Восстановить модель после сериализации.
protected смешанное getPropertyValue(ReflectionProperty $property)
Получить значение свойства для данного свойства.
пусто __construct(Модель $model, string $event)
Создать новый экземпляр события.
строка broadcastAs()
Имя события, под которым оно должно транслироваться.
массив|null broadcastWith()
Получить данные, которые должны быть отправлены вместе с транслируемым событием.
$this onChannels(array $channels)
Вручную указать каналы, на которых должно транслироваться событие.
булево shouldBroadcastNow()
Определить, должно ли событие транслироваться синхронно.
строка event()
Получить имя события.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Database/Eloquent/BroadcastableModelEventOccurred.html
