trait SoftDeletes

Properties

protected bool $forceDeleting

Indicates if the model is currently force deleting.

Methods

static void
bootSoftDeletes()

Boot the soft deleting trait for a model.

bool|null
forceDelete()

Force a hard delete on a soft deleted model.

mixed
performDeleteOnModel()

Perform the actual delete query on this model instance.

void
runSoftDelete()

Perform the actual delete query on this model instance.

bool|null
restore()

Restore a soft-deleted model instance.

bool
trashed()

Determine if the model instance has been soft-deleted.

static void
restoring(Closure|string $callback)

Register a restoring model event with the dispatcher.

static void
restored(Closure|string $callback)

Register a restored model event with the dispatcher.

bool
isForceDeleting()

Determine if the model is currently force deleting.

string
getDeletedAtColumn()

Get the name of the "deleted at" column.

string
getQualifiedDeletedAtColumn()

Get the fully qualified "deleted at" column.

Details

at line 19
static void bootSoftDeletes()

Boot the soft deleting trait for a model.

Return Value

void

at line 29
bool|null forceDelete()

Force a hard delete on a soft deleted model.

Return Value

bool|null

at line 45
protected mixed performDeleteOnModel()

Perform the actual delete query on this model instance.

Return Value

mixed

at line 59
protected void runSoftDelete()

Perform the actual delete query on this model instance.

Return Value

void

at line 83
bool|null restore()

Restore a soft-deleted model instance.

Return Value

bool|null

at line 111
bool trashed()

Determine if the model instance has been soft-deleted.

Return Value

bool

at line 122
static void restoring(Closure|string $callback)

Register a restoring model event with the dispatcher.

Parameters

Closure|string $callback

Return Value

void

at line 133
static void restored(Closure|string $callback)

Register a restored model event with the dispatcher.

Parameters

Closure|string $callback

Return Value

void

at line 143
bool isForceDeleting()

Determine if the model is currently force deleting.

Return Value

bool

at line 153
string getDeletedAtColumn()

Get the name of the "deleted at" column.

Return Value

string

at line 163
string getQualifiedDeletedAtColumn()

Get the fully qualified "deleted at" column.

Return Value

string