Arikaim CMS

QueueStorageInterface
in

Job recuring interface

Table of Contents

Methods

addJob()  : bool
Add job
deleteJob()  : bool
Delete job
deleteJobs()  : bool
Delete jobs
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
getNext()  : array<string|int, mixed>|null
Get next Job
hasJob()  : bool
Return true if job exists
setJobStatus()  : bool
Update execution status
updateExecutionStatus()  : bool
Update execution status

Methods

addJob()

Add job

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

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

getJob()

Get job

public getJob(string|int $id) : array<string|int, mixed>|null
Parameters
$id : string|int
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

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

getNext()

Get next Job

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

hasJob()

Return true if job exists

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

setJobStatus()

Update execution status

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

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results