1. trait
  2. Illuminate
  3. Database
  4. Eloquent
  5. SoftDeletingTrait

SoftDeletingTrait

trait SoftDeletingTrait (View source)

Methods

static  void
bootSoftDeletingTrait()

Boot the soft deleting trait for a model.

void
forceDelete()

Force a hard delete on a soft deleted model.

bool|null
restore()

Restore a soft-deleted model instance.

bool
trashed()

Determine if the model instance has been soft-deleted.

static  Builder|SoftDeletingTrait
withTrashed()

Get a new query builder that includes soft deletes.

static  Builder|SoftDeletingTrait
onlyTrashed()

Get a new query builder that only includes soft deletes.

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.

string
getDeletedAtColumn()

Get the name of the "deleted at" column.

string
getQualifiedDeletedAtColumn()

Get the fully qualified "deleted at" column.

Details

at line line 17
static void bootSoftDeletingTrait()

Boot the soft deleting trait for a model.

Return Value

void

at line line 27
void forceDelete()

Force a hard delete on a soft deleted model.

Return Value

void

at line line 70
bool|null restore()

Restore a soft-deleted model instance.

Return Value

bool|null

at line line 99
bool trashed()

Determine if the model instance has been soft-deleted.

Return Value

bool

at line line 109
static Builder|SoftDeletingTrait withTrashed()

Get a new query builder that includes soft deletes.

Return Value

Builder|SoftDeletingTrait

at line line 119
static Builder|SoftDeletingTrait onlyTrashed()

Get a new query builder that only includes soft deletes.

Return Value

Builder|SoftDeletingTrait

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

Register a restoring model event with the dispatcher.

Parameters

Closure|string $callback

Return Value

void

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

Register a restored model event with the dispatcher.

Parameters

Closure|string $callback

Return Value

void

at line line 155
string getDeletedAtColumn()

Get the name of the "deleted at" column.

Return Value

string

at line line 165
string getQualifiedDeletedAtColumn()

Get the fully qualified "deleted at" column.

Return Value

string