Arikaim CMS

Queue extends Model
in package
implements QueueStorageInterface Uses Uuid, Find, Status, OptionsAttribute, UserRelation, DateCreated

Queue database model

Table of Contents

Interfaces

QueueStorageInterface
Job recuring interface

Properties

$ACTIVE  : mixed
Active
$appends  : array<string|int, mixed>
Append custom attributes
$CANCELLED  : mixed
Cancelled
$COMPLETED  : mixed
Completed
$DISABLED  : mixed
Disabled
$PENDING  : mixed
Pending activation
$PUBLISHED  : mixed
Published
$SUSPENDED  : mixed
Suspended
$timestamps  : bool
Disable timestamps
$DEFAULT_STATUS_COLUMN  : string
Default status column name
$DEFAULT_USER_COLUMN  : string
Default user column name
$DEFAULT_UUID_COLUMN  : string
Default uuid column name
$fillable  : array<string|int, mixed>
Fillable attributes
$optionsColumnName  : string
Options column name
$statusText  : array<string|int, mixed>
Status text
$table  : string
Db table name

Methods

ACTIVE()  : int
Return active value
addJob()  : bool
Add job
bootDateCreated()  : void
Set model events
bootUserRelation()  : void
Init model events.
bootUuid()  : void
Init model events.
CANCELLED()  : int
Cancelled
COMPLETED()  : int
Return completed value
deleteJob()  : bool
Delete job
deleteJobs()  : bool
Delete jobs
DISABLED()  : int
Return disabled value
findByColumn()  : Model|null
Find model by column name
findById()  : Model|null
Find model by id or uuid
findByIdQuery()  : Builder
Return query builder
findItems()  : QueryBuilder|false
Find collection of models by id or uuid
findMultiple()  : Builder
Find multiole query
findQuery()  : Builder
Return query builder
getActive()  : Builder
Return active model query builder
getAuthId()  : mixed
Get current auth id
getDateCreatedAttributeName()  : string
Get date created attribute
getDisabled()  : Builder
Return disabled model query builder
getDueDateAttribute()  : int|null
Get attribute mutator for due_date
getIdAttributeName()  : string
Return id column name dependiv of id value type for string return uuid
getJob()  : array<string|int, mixed>|null
Get job
getJobId()  : string|false
Find job and return job id
getJobs()  : array<string|int, mixed>
Get jobs
getJobsDue()  : array<string|int, mixed>|null
Get all jobs due or filter by name
getJobsDueQuery()  : Builder
Get jobs due query
getLastId()  : int|null
Get last id
getLastRow()  : Model|null
Get last row
getNext()  : array<string|int, mixed>|null
Get next Job
getOption()  : mixed
Get option from options array
getOptionsAttribute()  : array<string|int, mixed>
Mutator (get) for options attribute.
getOptionsColumnName()  : string
Get options column name
hasAttribute()  : bool
Return true if atr exist
hasJob()  : bool
Return true if job exists
isRecurring()  : bool
Return true if job is recurring
isScheduled()  : bool
Return true if job is scheduled
PENDING()  : int
Pending activation
resolveStatusText()  : int|false
Resolve status id
resolveStatusValue()  : int
Get status value
saveJobConfigParam()  : bool
Update job config param
saveOption()  : bool
Save option
saveOptions()  : bool
Save options
scopeActiveQuery()  : Builder
Active status scope
scopeSearchIgnoreCase()  : Builder
Case insensitive search
scopeStatusQuery()  : Builder
Status scope
scopeUserQuery()  : Builder
Filter by user
scopeUserQueryWithPublic()  : Builder
Filter rows by user + null (public)
setJobStatus()  : bool
Update execution status
setStatus()  : bool
Set model status
SUSPENDED()  : int
Suspended
updateExecutionStatus()  : bool
Update execution status
user()  : Relation|null
Get user relation
whereIgnoreCase()  : Builder
Where case insensitive

Properties

$ACTIVE

Active

public static mixed $ACTIVE = 1

$appends

Append custom attributes

public array<string|int, mixed> $appends = ['due_date', 'options']

$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

$timestamps

Disable timestamps

public bool $timestamps = false

$DEFAULT_STATUS_COLUMN

Default status column name

protected static string $DEFAULT_STATUS_COLUMN = 'status'

$DEFAULT_USER_COLUMN

Default user column name

protected static string $DEFAULT_USER_COLUMN = 'user_id'

$DEFAULT_UUID_COLUMN

Default uuid column name

protected static string $DEFAULT_UUID_COLUMN = 'uuid'

$fillable

Fillable attributes

protected array<string|int, mixed> $fillable = ['name', 'priority', 'recuring_interval', 'handler_class', 'status', 'user_id', 'extension_name', 'schedule_time', 'date_created', 'date_executed', 'executed', 'config', 'type', 'service_name', 'queue']

$optionsColumnName

Options column name

protected string $optionsColumnName = 'config'

$statusText

Status text

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

$table

Db table name

protected string $table = 'queue'

Methods

ACTIVE()

Return active value

public ACTIVE() : int
Return values
int

addJob()

Add job

public addJob(array<string|int, mixed> $data) : bool
Parameters
$data : array<string|int, mixed>
Return values
bool

bootDateCreated()

Set model events

public static bootDateCreated() : void

bootUserRelation()

Init model events.

public static bootUserRelation() : void

bootUuid()

Init model events.

public static bootUuid() : void

CANCELLED()

Cancelled

public CANCELLED() : int
Return values
int

COMPLETED()

Return completed value

public COMPLETED() : int
Return values
int

deleteJob()

Delete job

public deleteJob(string|int $id) : bool
Parameters
$id : string|int
Return values
bool

deleteJobs()

Delete jobs

public deleteJobs([array<string|int, mixed> $filter = [] ]) : bool
Parameters
$filter : array<string|int, mixed> = []
Return values
bool

DISABLED()

Return disabled value

public DISABLED() : int
Return values
int

findByColumn()

Find model by column name

public findByColumn(mixed $value[, string|null|array<string|int, mixed> $column = null ]) : Model|null
Parameters
$value : mixed
$column : string|null|array<string|int, mixed> = null
Return values
Model|null

findById()

Find model by id or uuid

public findById(int|string $id) : Model|null
Parameters
$id : int|string
Return values
Model|null

findByIdQuery()

Return query builder

public findByIdQuery(int|string $id) : Builder
Parameters
$id : int|string
Return values
Builder

findItems()

Find collection of models by id or uuid

public findItems(array<string|int, mixed>|null $items) : QueryBuilder|false
Parameters
$items : array<string|int, mixed>|null
Return values
QueryBuilder|false

findMultiple()

Find multiole query

public findMultiple(array<string|int, mixed> $idList) : Builder
Parameters
$idList : array<string|int, mixed>
Return values
Builder

findQuery()

Return query builder

public findQuery(mixed $value[, string|null|array<string|int, mixed> $column = null ]) : Builder
Parameters
$value : mixed
$column : string|null|array<string|int, mixed> = null
Return values
Builder

getActive()

Return active model query builder

public getActive() : Builder
Return values
Builder

getAuthId()

Get current auth id

public getAuthId() : mixed

getDateCreatedAttributeName()

Get date created attribute

public getDateCreatedAttributeName() : string
Return values
string

getDisabled()

Return disabled model query builder

public getDisabled() : Builder
Return values
Builder

getDueDateAttribute()

Get attribute mutator for due_date

public getDueDateAttribute() : int|null
Return values
int|null

getIdAttributeName()

Return id column name dependiv of id value type for string return uuid

public getIdAttributeName(int|string $id) : string
Parameters
$id : int|string
Return values
string

getJob()

Get job

public getJob(string|int $id) : array<string|int, mixed>|null
Parameters
$id : string|int

Job id or uiid

Return values
array<string|int, mixed>|null

getJobId()

Find job and return job id

public getJobId([array<string|int, mixed> $filter = [] ]) : string|false
Parameters
$filter : array<string|int, mixed> = []
Return values
string|false

getJobs()

Get jobs

public getJobs([array<string|int, mixed> $filter = [] ]) : array<string|int, mixed>
Parameters
$filter : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getJobsDue()

Get all jobs due or filter by name

public getJobsDue([string|null $jobName = null ]) : array<string|int, mixed>|null
Parameters
$jobName : string|null = null
Return values
array<string|int, mixed>|null

getJobsDueQuery()

Get jobs due query

public getJobsDueQuery([string|null $jobName = null ]) : Builder
Parameters
$jobName : string|null = null
Return values
Builder

getLastId()

Get last id

public getLastId() : int|null
Return values
int|null

getLastRow()

Get last row

public getLastRow([string $field = 'id' ]) : Model|null
Parameters
$field : string = 'id'
Return values
Model|null

getNext()

Get next Job

public getNext() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getOption()

Get option from options array

public getOption(string $key[, mixed $default = null ]) : mixed
Parameters
$key : string
$default : mixed = null

getOptionsAttribute()

Mutator (get) for options attribute.

public getOptionsAttribute() : array<string|int, mixed>
Return values
array<string|int, mixed>

getOptionsColumnName()

Get options column name

public getOptionsColumnName() : string
Return values
string

hasAttribute()

Return true if atr exist

public hasAttribute(string $attr) : bool
Parameters
$attr : string
Return values
bool

hasJob()

Return true if job exists

public hasJob(string|int $id) : bool
Parameters
$id : string|int

Job id, uiid

Return values
bool

isRecurring()

Return true if job is recurring

public isRecurring() : bool
Return values
bool

isScheduled()

Return true if job is scheduled

public isScheduled() : bool
Return values
bool

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

saveJobConfigParam()

Update job config param

public saveJobConfigParam(string|int $id, string $key, mixed $value) : bool
Parameters
$id : string|int

Job id

$key : string
$value : mixed
Return values
bool

saveOption()

Save option

public saveOption(string $key, mixed $value) : bool
Parameters
$key : string
$value : mixed
Return values
bool

saveOptions()

Save options

public saveOptions(array<string|int, mixed> $options) : bool
Parameters
$options : array<string|int, mixed>
Return values
bool

scopeActiveQuery()

Active status scope

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

scopeSearchIgnoreCase()

Case insensitive search

public scopeSearchIgnoreCase(Builder $query, string $column, string|null $value) : Builder
Parameters
$query : Builder
$column : string
$value : string|null
Return values
Builder

scopeStatusQuery()

Status scope

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

scopeUserQuery()

Filter by user

public scopeUserQuery(Builder $query, int|null $userId) : Builder
Parameters
$query : Builder
$userId : int|null
Return values
Builder

scopeUserQueryWithPublic()

Filter rows by user + null (public)

public scopeUserQueryWithPublic(Builder $query, int|null $userId) : Builder
Parameters
$query : Builder
$userId : int|null
Return values
Builder

setJobStatus()

Update execution status

public setJobStatus(string|int $id, int $status) : bool
Parameters
$id : string|int
$status : int
Return values
bool

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

updateExecutionStatus()

Update execution status

public updateExecutionStatus(JobInterface $job) : bool
Parameters
$job : JobInterface
Return values
bool

user()

Get user relation

public user() : Relation|null
Return values
Relation|null

whereIgnoreCase()

Where case insensitive

public whereIgnoreCase(string $attribute, mixed $value[, string $operator = '=' ]) : Builder
Parameters
$attribute : string
$value : mixed
$operator : string = '='
Return values
Builder 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results