W3cubDocs

/Laravel 11

BroadcastsEventsAfterCommit

trait BroadcastsEventsAfterCommit (View source)

Traits

BroadcastsEvents

Methods

static void bootBroadcastsEvents()

Boot the event broadcasting trait.

 from BroadcastsEvents
PendingBroadcast broadcastCreated(Channel|HasBroadcastChannel|array|null $channels = null)

Broadcast that the model was created.

 from BroadcastsEvents
PendingBroadcast broadcastUpdated(Channel|HasBroadcastChannel|array|null $channels = null)

Broadcast that the model was updated.

 from BroadcastsEvents
PendingBroadcast broadcastTrashed(Channel|HasBroadcastChannel|array|null $channels = null)

Broadcast that the model was trashed.

 from BroadcastsEvents
PendingBroadcast broadcastRestored(Channel|HasBroadcastChannel|array|null $channels = null)

Broadcast that the model was restored.

 from BroadcastsEvents
PendingBroadcast broadcastDeleted(Channel|HasBroadcastChannel|array|null $channels = null)

Broadcast that the model was deleted.

 from BroadcastsEvents
PendingBroadcast|null broadcastIfBroadcastChannelsExistForEvent(mixed $instance, string $event, mixed $channels = null)

Broadcast the given event instance if channels are configured for the model event.

 from BroadcastsEvents
mixed newBroadcastableModelEvent(string $event)

Create a new broadcastable model event event.

 from BroadcastsEvents
BroadcastableModelEventOccurred newBroadcastableEvent(string $event)

Create a new broadcastable model event for the model.

 from BroadcastsEvents
Channel|array broadcastOn(string $event)

Get the channels that model events should broadcast on.

 from BroadcastsEvents
string|null broadcastConnection()

Get the queue connection that should be used to broadcast model events.

 from BroadcastsEvents
string|null broadcastQueue()

Get the queue that should be used to broadcast model events.

 from BroadcastsEvents
bool broadcastAfterCommit()

Determine if the model event broadcast queued job should be dispatched after all transactions are committed.

Details

static void bootBroadcastsEvents()

Boot the event broadcasting trait.

Return Value

void

PendingBroadcast broadcastCreated(Channel|HasBroadcastChannel|array|null $channels = null)

Broadcast that the model was created.

Parameters

Channel|HasBroadcastChannel|array|null $channels

Return Value

PendingBroadcast

PendingBroadcast broadcastUpdated(Channel|HasBroadcastChannel|array|null $channels = null)

Broadcast that the model was updated.

Parameters

Channel|HasBroadcastChannel|array|null $channels

Return Value

PendingBroadcast

PendingBroadcast broadcastTrashed(Channel|HasBroadcastChannel|array|null $channels = null)

Broadcast that the model was trashed.

Parameters

Channel|HasBroadcastChannel|array|null $channels

Return Value

PendingBroadcast

PendingBroadcast broadcastRestored(Channel|HasBroadcastChannel|array|null $channels = null)

Broadcast that the model was restored.

Parameters

Channel|HasBroadcastChannel|array|null $channels

Return Value

PendingBroadcast

PendingBroadcast broadcastDeleted(Channel|HasBroadcastChannel|array|null $channels = null)

Broadcast that the model was deleted.

Parameters

Channel|HasBroadcastChannel|array|null $channels

Return Value

PendingBroadcast

protected PendingBroadcast|null broadcastIfBroadcastChannelsExistForEvent(mixed $instance, string $event, mixed $channels = null)

Broadcast the given event instance if channels are configured for the model event.

Parameters

mixed $instance
string $event
mixed $channels

Return Value

PendingBroadcast|null

mixed newBroadcastableModelEvent(string $event)

Create a new broadcastable model event event.

Parameters

string $event

Return Value

mixed

protected BroadcastableModelEventOccurred newBroadcastableEvent(string $event)

Create a new broadcastable model event for the model.

Parameters

string $event

Return Value

BroadcastableModelEventOccurred

Channel|array broadcastOn(string $event)

Get the channels that model events should broadcast on.

Parameters

string $event

Return Value

Channel|array

string|null broadcastConnection()

Get the queue connection that should be used to broadcast model events.

Return Value

string|null

string|null broadcastQueue()

Get the queue that should be used to broadcast model events.

Return Value

string|null

bool broadcastAfterCommit()

Determine if the model event broadcast queued job should be dispatched after all transactions are committed.

Return Value

bool

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Database/Eloquent/BroadcastsEventsAfterCommit.html