BroadcastableModelEventOccurred
class BroadcastableModelEventOccurred implements ShouldBroadcast (View source)
Traits
Properties
| 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. |
Methods
Exclude the current user from receiving the broadcast.
Get the property value prepared for serialization.
Get the restored property value after deserialization.
The channels the event should broadcast on.
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.
Details
$this
dontBroadcastToCurrentUser()
Exclude the current user from receiving the broadcast.
$this
broadcastToEveryone()
Broadcast the event to everyone.
protected mixed
getSerializedPropertyValue(mixed $value, bool $withRelations = true)
Get the property value prepared for serialization.
protected mixed
getRestoredPropertyValue(mixed $value)
Get the restored property value after deserialization.
protected Collection
restoreCollection(ModelIdentifier $value)
Restore a queueable collection instance.
Model
restoreModel(ModelIdentifier $value)
Restore the model from the model identifier instance.
protected Builder
getQueryForModelRestoration(Model $model, array|int $ids)
Get the query for model restoration.
array
__serialize()
Prepare the instance values for serialization.
void
__unserialize(array $values)
Restore the model after serialization.
protected mixed
getPropertyValue(ReflectionProperty $property)
Get the property value for the given property.
void
__construct(Model $model, string $event)
Create a new event instance.
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.