1. interface
  2. Arikaim
  3. \
  4. Core
  5. \
  6. Interfaces
  7. \
  8. QueueInterface

QueueInterface

interface QueueInterface

Queue interface

Methods

bool
addJob(JobInterface $job, string|null $extension = null, bool $disabled = false, string|null $recuringInterval = null, int|null $scheduleTime = null, array|null $config = null)

Add job to queue

bool
deleteJob(string|integer $id)

Delete job

boolean
clear()

Delete all jobs

JobInterface|null
getNext()

Get next job

JobInterface|null
run(string|int $name, Closure|null $onJobProgress = null, Closure|null $onJobProgressError = null)

Run job

JobInterface|null
executeJob(JobInterface $job, Closure|null $onJobProgress = null, Closure|null $onJobProgressError = null)

Execute job

array|null
getJobsDue()

Get all jobs due

array|null
getJobs(array $filter = [])

Get jobs

array|null
getRecuringJobs(string|null $extension = null)

Get recurring jobs

JobInterface|null
create(string|integer $name)

Create job obj from jobs queue

bool
deleteJobs(array $filter = [])

Delete jobs

array|null
getJob(string|integer $id)

Find job by name, id or uuid

Details

at line 31
bool addJob(JobInterface $job, string|null $extension = null, bool $disabled = false, string|null $recuringInterval = null, int|null $scheduleTime = null, array|null $config = null)

Add job to queue

Parameters

JobInterface $job
string|null $extension
bool $disabled
string|null $recuringInterval
int|null $scheduleTime
array|null $config

Return Value

bool

at line 46
bool deleteJob(string|integer $id)

Delete job

Parameters

string|integer $id Job id, uiid

Return Value

bool

at line 53
boolean clear()

Delete all jobs

Return Value

boolean

at line 60
JobInterface|null getNext()

Get next job

Return Value

JobInterface|null

at line 70
JobInterface|null run(string|int $name, Closure|null $onJobProgress = null, Closure|null $onJobProgressError = null)

Run job

Parameters

string|int $name
Closure|null $onJobProgress
Closure|null $onJobProgressError

Return Value

JobInterface|null

at line 80
JobInterface|null executeJob(JobInterface $job, Closure|null $onJobProgress = null, Closure|null $onJobProgressError = null)

Execute job

Parameters

JobInterface $job
Closure|null $onJobProgress
Closure|null $onJobProgressError

Return Value

JobInterface|null

at line 87
array|null getJobsDue()

Get all jobs due

Return Value

array|null

at line 95
array|null getJobs(array $filter = [])

Get jobs

Parameters

array $filter

Return Value

array|null

at line 103
array|null getRecuringJobs(string|null $extension = null)

Get recurring jobs

Parameters

string|null $extension

Return Value

array|null

at line 111
JobInterface|null create(string|integer $name)

Create job obj from jobs queue

Parameters

string|integer $name

Return Value

JobInterface|null

at line 119
bool deleteJobs(array $filter = [])

Delete jobs

Parameters

array $filter

Return Value

bool

at line 127
array|null getJob(string|integer $id)

Find job by name, id or uuid

Parameters

string|integer $id Job id, uiid or name

Return Value

array|null