BroadcastableModelEventOccurred
class BroadcastableModelEventOccurred implements ShouldBroadcast
Traits
Properties
| string|null | $socket | The socket ID for the user that raised the event. |
from InteractsWithSockets |
| protected array | $channels | The channels that the event should be broadcast on. |
|
| string|null | $connection | The queue connection that should be used to queue the broadcast job. |
|
| string|null | $queue | The queue that should be used to queue the broadcast job. |
|
| bool | $afterCommit | Indicates whether the job should be dispatched after all database transactions have committed. |
Methods
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.
Get the query for model restoration.
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
in
InteractsWithSockets at line 19
InteractsWithSockets
dontBroadcastToCurrentUser()
Exclude the current user from receiving the broadcast.
in
InteractsWithSockets at line 29
InteractsWithSockets
broadcastToEveryone()
Broadcast the event to everyone.
in
SerializesAndRestoresModelIdentifiers at line 20
protected mixed
getSerializedPropertyValue(mixed $value, bool $withRelations = true)
Get the property value prepared for serialization.
in
SerializesAndRestoresModelIdentifiers at line 54
protected mixed
getRestoredPropertyValue(mixed $value)
Get the restored property value after deserialization.
in
SerializesAndRestoresModelIdentifiers at line 68
protected Collection
restoreCollection(ModelIdentifier $value)
Restore a queueable collection instance.
in
SerializesAndRestoresModelIdentifiers at line 109
Model
restoreModel(ModelIdentifier $value)
Restore the model from the model identifier instance.
in
SerializesAndRestoresModelIdentifiers at line 123
protected Builder
getQueryForModelRestoration(Model $model, array|int|string $ids)
Get the query for model restoration.
in
SerializesModels at line 18
array
__serialize()
Prepare the instance values for serialization.
in
SerializesModels at line 68
void
__unserialize(array $values)
Restore the model after serialization.
in
SerializesModels at line 101
protected mixed
getPropertyValue(ReflectionProperty $property)
Get the property value for the given property.
at line 44
__construct(Model $model, string $event)
Create a new event instance.
at line 53
array|Channel
broadcastOn()
The channels the event should broadcast on.
at line 67
string
broadcastAs()
The name the event should broadcast as.
at line 79
array|null
broadcastWith()
Get the data that should be sent with the broadcasted event.
at line 89
BroadcastableModelEventOccurred
onChannels(array $channels)
Manually specify the channels the event should broadcast on.
at line 99
bool
shouldBroadcastNow()
Determine if the event should be broadcast synchronously.
at line 108
string
event()
Get the event name.