class BroadcastableModelEventOccurred implements ShouldBroadcast (View source)
| InteractsWithSockets | |
| SerializesModels | |
| SerializesAndRestoresModelIdentifiers |
| string|null | $socket | The socket ID for the user that raised the event. | from InteractsWithSockets |
| Model | $model | The model instance corresponding to the event. | |
| protected string | $event | The event name (created, updated, etc.). | |
| protected array | $channels | The channels that the event should be broadcast on. | |
| string | $connection | The queue connection that should be used to queue the broadcast job. | |
| string | $queue | The queue that should be used to queue the broadcast job. | |
| bool|null | $afterCommit | Indicates whether the job should be dispatched after all database transactions have committed. |
| $this | dontBroadcastToCurrentUser()
Exclude the current user from receiving the broadcast. | from InteractsWithSockets |
| $this | broadcastToEveryone()
Broadcast the event to everyone. | from InteractsWithSockets |
| mixed | getSerializedPropertyValue(mixed $value, bool $withRelations = true)
Get the property value prepared for serialization. | from SerializesAndRestoresModelIdentifiers |
| mixed | getRestoredPropertyValue(mixed $value)
Get the restored property value after deserialization. | from SerializesAndRestoresModelIdentifiers |
| Collection | restoreCollection(ModelIdentifier $value)
Restore a queueable collection instance. | from SerializesAndRestoresModelIdentifiers |
| Model | restoreModel(ModelIdentifier $value)
Restore the model from the model identifier instance. | from SerializesAndRestoresModelIdentifiers |
| TModel> | getQueryForModelRestoration(TModel $model, array|int $ids)
Get the query for model restoration. | from SerializesAndRestoresModelIdentifiers |
| array | __serialize()
Prepare the instance values for serialization. | from SerializesModels |
| void | __unserialize(array $values)
Restore the model after serialization. | from SerializesModels |
| mixed | getPropertyValue(ReflectionProperty $property)
Get the property value for the given property. | from SerializesModels |
| void | __construct(Model $model, string $event)
Create a new event instance. | |
| Channel|Channel[]|string[]|string | broadcastOn()
The channels the event should broadcast on. | |
| string | broadcastAs()
The name the event should broadcast as. | |
| array|null | broadcastWith()
Get the data that should be sent with the broadcasted event. | |
| $this | onChannels(array $channels)
Manually specify the channels the event should broadcast on. | |
| bool | shouldBroadcastNow()
Determine if the event should be broadcast synchronously. | |
| string | event()
Get the event name. |
Exclude the current user from receiving the broadcast.
Broadcast the event to everyone.
Get the property value prepared for serialization.
Get the restored property value after deserialization.
Restore a queueable collection instance.
Restore the model from the model identifier instance.
Get the query for model restoration.
Prepare the instance values for serialization.
Restore the model after serialization.
Get the property value for the given property.
Create a new event instance.
The name the event should broadcast as.
Get the data that should be sent with the broadcasted event.
Manually specify the channels the event should broadcast on.
Determine if the event should be broadcast synchronously.
Get the event name.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Database/Eloquent/BroadcastableModelEventOccurred.html