BroadcastableModelEventOccurred

class BroadcastableModelEventOccurred implements ShouldBroadcast (View source)

Traits

InteractsWithSockets
SerializesModels
SerializesAndRestoresModelIdentifiers

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

$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)

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
Builder getQueryForModelRestoration(Model $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.

Details

$this dontBroadcastToCurrentUser()

Exclude the current user from receiving the broadcast.

Return Value

$this

$this broadcastToEveryone()

Broadcast the event to everyone.

Return Value

$this

protected mixed getSerializedPropertyValue(mixed $value)

Get the property value prepared for serialization.

Parameters

mixed $value

Return Value

mixed

protected mixed getRestoredPropertyValue(mixed $value)

Get the restored property value after deserialization.

Parameters

mixed $value

Return Value

mixed

protected Collection restoreCollection(ModelIdentifier $value)

Restore a queueable collection instance.

Parameters

ModelIdentifier $value

Return Value

Collection

Model restoreModel(ModelIdentifier $value)

Restore the model from the model identifier instance.

Parameters

ModelIdentifier $value

Return Value

Model

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

Get the query for model restoration.

Parameters

Model $model
array|int $ids

Return Value

Builder

array __serialize()

Prepare the instance values for serialization.

Return Value

array

void __unserialize(array $values)

Restore the model after serialization.

Parameters

array $values

Return Value

void

protected mixed getPropertyValue(ReflectionProperty $property)

Get the property value for the given property.

Parameters

ReflectionProperty $property

Return Value

mixed

void __construct(Model $model, string $event)

Create a new event instance.

Parameters

Model $model
string $event

Return Value

void

Channel|Channel[]|string[]|string broadcastOn()

The channels the event should broadcast on.

Return Value

Channel|Channel[]|string[]|string

string broadcastAs()

The name the event should broadcast as.

Return Value

string

array|null broadcastWith()

Get the data that should be sent with the broadcasted event.

Return Value

array|null

$this onChannels(array $channels)

Manually specify the channels the event should broadcast on.

Parameters

array $channels

Return Value

$this

bool shouldBroadcastNow()

Determine if the event should be broadcast synchronously.

Return Value

bool

string event()

Get the event name.

Return Value

string

© 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