1. trait
  2. Arikaim
  3. \
  4. Core
  5. \
  6. Db
  7. \
  8. Traits
  9. \
  10. SoftDelete

SoftDelete

trait SoftDelete

Soft delete trait

Methods

bool
isDeleted()

Return true if model is deleted

int
getDeletedCount()

Get delete models count.

bool
softDelete(integer|string|null $id = null)

Soft delete model

bool
restore(integer|string|null $id = null)

Restore soft deleted models

bool
restoreAll()

Restore all soft deleted rows

QueryBuilder
softDeletedQuery()

Get soft deleted query

bool
clearDeleted()

Permanently delete all soft deleted models

QueryBuilder
getNotDeletedQuery()

Get not deleted query

Builder
scopeGetNotDeleted(Builder $query)

Get not deleted scope

Builder
scopeGetDeleted(Builder $query)

Get deleted scope

string
getDeletedColumn()

Get uuid attribute name

Details

at line 25
bool isDeleted()

Return true if model is deleted

Return Value

bool

at line 35
int getDeletedCount()

Get delete models count.

Return Value

int

at line 48
bool softDelete(integer|string|null $id = null)

Soft delete model

Parameters

integer|string|null $id string $id

Return Value

bool

at line 64
bool restore(integer|string|null $id = null)

Restore soft deleted models

Parameters

integer|string|null $id string $id

Return Value

bool

at line 78
bool restoreAll()

Restore all soft deleted rows

Return Value

bool

at line 93
QueryBuilder softDeletedQuery()

Get soft deleted query

Return Value

QueryBuilder

at line 103
bool clearDeleted()

Permanently delete all soft deleted models

Return Value

bool

at line 113
QueryBuilder getNotDeletedQuery()

Get not deleted query

Return Value

QueryBuilder

at line 124
Builder scopeGetNotDeleted(Builder $query)

Get not deleted scope

Parameters

Builder $query

Return Value

Builder

at line 135
Builder scopeGetDeleted(Builder $query)

Get deleted scope

Parameters

Builder $query

Return Value

Builder

at line 145
string getDeletedColumn()

Get uuid attribute name

Return Value

string