trait Status

Update Status field Change default status column name in model: protected $statusColumn = 'column name';

Properties

static $DISABLED Disabled
static $ACTIVE Active
static $COMPLETED Completed
static $PUBLISHED Published
static $PENDING Pending activation
static $SUSPENDED Suspended
protected array $statusText Status text

Methods

int
ACTIVE()

Return active value

int
DISABLED()

Return disabled value

int
COMPLETED()

Return completed value

int
PENDING()

Pending activation

int
SUSPENDED()

Suspended

Builder
scopeStatusQuery(Builder $query, mixed $items)

Status scope

string
getStatusColumn()

Get status column name

integer|false
resolveStatusText(string|int $status)

Resolve status id

Builder
getActive()

Return active model query builder

Builder
scopeActiveQuery(Builder $query)

Active status scope

Builder
getDisabled()

Return disabled model query builder

bool
setStatus(integer|string|null $status = null)

Set model status

int
resolveStatusValue(integer|null|string $status = null)

Get status value

Details

at line 54
int ACTIVE()

Return active value

Return Value

int

at line 64
int DISABLED()

Return disabled value

Return Value

int

at line 74
int COMPLETED()

Return completed value

Return Value

int

at line 84
int PENDING()

Pending activation

Return Value

int

at line 94
int SUSPENDED()

Suspended

Return Value

int

at line 120
Builder scopeStatusQuery(Builder $query, mixed $items)

Status scope

Parameters

Builder $query
mixed $items

Return Value

Builder

at line 135
string getStatusColumn()

Get status column name

Return Value

string

at line 146
integer|false resolveStatusText(string|int $status)

Resolve status id

Parameters

string|int $status

Return Value

integer|false

at line 160
Builder getActive()

Return active model query builder

Return Value

Builder

at line 176
Builder scopeActiveQuery(Builder $query)

Active status scope

Parameters

Builder $query

Return Value

Builder

at line 186
Builder getDisabled()

Return disabled model query builder

Return Value

Builder

at line 197
bool setStatus(integer|string|null $status = null)

Set model status

Parameters

integer|string|null $status

Return Value

bool

at line 211
int resolveStatusValue(integer|null|string $status = null)

Get status value

Parameters

integer|null|string $status

Return Value

int