Craft 3 Class Reference

Appearance

QueueInterface ​

Type
Interface
Namespace
craft\queue
Implemented by
craft\queue\Queue
Since
3.0.0

QueueInterface defines the common interface to be implemented by queue classes.

View source

Public Methods ​

MethodDescription
getHasReservedJobs()Returns whether there are any reserved jobs.
getHasWaitingJobs()Returns whether there are any waiting jobs.
getJobDetails()Returns detailed info about a single job.
getJobInfo()Returns info about the jobs in the queue.
getTotalJobs()Returns the total number of jobs in the queue.
release()Releases a job from the queue.
releaseAll()Releases all jobs.
retry()Re-adds a failed job to the queue.
retryAll()Retries all failed jobs.
run()Runs all the queued-up jobs.
setProgress()Sets the progress for the currently reserved job.

getHasReservedJobs() ​

Returns whether there are any reserved jobs.

View source

Returns ​

boolean

getHasWaitingJobs() ​

Returns whether there are any waiting jobs.

View source

Returns ​

boolean

getJobDetails() ​

Since
3.4.0

Returns detailed info about a single job.

The response array can contain the following keys:

  • delay – the number of seconds remaining before the job will start
  • status – the job status (1 = waiting, 2 = reserved, 3 = done, 4 = failed)
  • progress – the job progress (0-100)
  • description – the job description
  • ttr – the job’s time-to-reserve, in seconds
  • error – the error message (if the job failed)
  • job – the deserialized job

Any other key/value pairs are allowed and will be displayed on the details page.

View source

Arguments ​

Returns ​

array

Throws ​

getJobInfo() ​

Returns info about the jobs in the queue.

The response array should have sub-arrays with the following keys:

  • id – the job ID
  • delay – the number of seconds remaining before the job will start
  • status – the job status (1 = waiting, 2 = reserved, 3 = done, 4 = failed)
  • progress – the job progress (0-100)
  • description – the job description
  • error – the error message (if the job failed)

View source

Arguments ​

Returns ​

array

getTotalJobs() ​

Since
3.4.0

Returns the total number of jobs in the queue.

View source

Returns ​

integer, float

release() ​

Releases a job from the queue.

View source

Arguments ​

releaseAll() ​

Since
3.4.0

Releases all jobs.

View source

retry() ​

Re-adds a failed job to the queue.

View source

Arguments ​

retryAll() ​

Since
3.4.0

Retries all failed jobs.

View source

run() ​

Runs all the queued-up jobs.

View source

setProgress() ​

Sets the progress for the currently reserved job.

View source

Arguments ​

  • $progress (integer) – The job progress (1-100)
  • $label (string, null) – The progress label