Arikaim CMS

Status

Update Status field

Default status column name in model: protected $statusColumn = 'column name';

Table of Contents

Properties

$ACTIVE  : mixed
Active
$CANCELLED  : mixed
Cancelled
$COMPLETED  : mixed
Completed
$DISABLED  : mixed
Disabled
$PENDING  : mixed
Pending activation
$PUBLISHED  : mixed
Published
$SUSPENDED  : mixed
Suspended
$DEFAULT_STATUS_COLUMN  : string
Default status column name
$statusText  : array<string|int, mixed>
Status text

Methods

ACTIVE()  : int
Return active value
CANCELLED()  : int
Cancelled
COMPLETED()  : int
Return completed value
DISABLED()  : int
Return disabled value
getActive()  : Builder
Return active model query builder
getDisabled()  : Builder
Return disabled model query builder
PENDING()  : int
Pending activation
resolveStatusText()  : int|false
Resolve status id
resolveStatusValue()  : int
Get status value
scopeActiveQuery()  : Builder
Active status scope
scopeStatusQuery()  : Builder
Status scope
setStatus()  : bool
Set model status
SUSPENDED()  : int
Suspended

Properties

$ACTIVE

Active

public static mixed $ACTIVE = 1

$CANCELLED

Cancelled

public static mixed $CANCELLED = 6

$COMPLETED

Completed

public static mixed $COMPLETED = 2

$DISABLED

Disabled

public static mixed $DISABLED = 0

$PENDING

Pending activation

public static mixed $PENDING = 4

$PUBLISHED

Published

public static mixed $PUBLISHED = 3

$SUSPENDED

Suspended

public static mixed $SUSPENDED = 5

$DEFAULT_STATUS_COLUMN

Default status column name

protected static string $DEFAULT_STATUS_COLUMN = 'status'

$statusText

Status text

protected array<string|int, mixed> $statusText = ['disabled', 'active', 'completed', 'published', 'pending', 'suspended', 'cancelled']

Methods

ACTIVE()

Return active value

public ACTIVE() : int
Return values
int

CANCELLED()

Cancelled

public CANCELLED() : int
Return values
int

COMPLETED()

Return completed value

public COMPLETED() : int
Return values
int

DISABLED()

Return disabled value

public DISABLED() : int
Return values
int

getActive()

Return active model query builder

public getActive() : Builder
Return values
Builder

getDisabled()

Return disabled model query builder

public getDisabled() : Builder
Return values
Builder

PENDING()

Pending activation

public PENDING() : int
Return values
int

resolveStatusText()

Resolve status id

public resolveStatusText(string|int $status) : int|false
Parameters
$status : string|int
Return values
int|false

resolveStatusValue()

Get status value

public resolveStatusValue([int|null|string $status = null ]) : int
Parameters
$status : int|null|string = null
Return values
int

scopeActiveQuery()

Active status scope

public scopeActiveQuery(Builder $query) : Builder
Parameters
$query : Builder
Return values
Builder

scopeStatusQuery()

Status scope

public scopeStatusQuery(Builder $query, mixed $items) : Builder
Parameters
$query : Builder
$items : mixed
Return values
Builder

setStatus()

Set model status

public setStatus([int|string|null $status = null ]) : bool
Parameters
$status : int|string|null = null
Return values
bool

SUSPENDED()

Suspended

public SUSPENDED() : int
Return values
int 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results