Queue

Type: Class
Namespace: craft\queue
Inherits: craft\queue\Queue » yii\queue\cli\Queue » yii\queue\Queue » yii\base\Component » yii\base\BaseObject
Implements: craft\queue\QueueInterface, yii\base\BootstrapInterface, yii\base\Configurable
Since: 3.0.0

Craft Queue

Public Properties

Property	Description
attempts	integer – Default attempt count
behaviors	yii\base\Behavior – List of behaviors attached to this component.
channel	string, null – The `channel` column value to the queue should use.
commandClass	string – Command class name
commandOptions	array – Of additional options of command
db	craft\db\Connection, array, string – The database connection to use
hasReservedJobs	boolean
hasWaitingJobs	boolean
jobId	string
jobInfo	array
loopConfig	array, string
mutex	yii\mutex\Mutex, array, string – The mutex component to use
mutexTimeout	integer – The time (in seconds) to wait for mutex locks to be released when attempting to reserve new jobs.
progress	integer – The job progress (1-100)
proxyQueue	yii\queue\Queue, array, string, null – An external queue that proxy jobs should be sent to.
serializer	yii\queue\serializers\SerializerInterface, array
strictJobType	boolean – Whether to enable strict job type control.
tableName	string – The table name the queue is stored in.
totalDelayed	integer
totalFailed	integer
totalJobs	integer
totalReserved	integer
totalWaiting	integer
ttr	integer – Default time to reserve a job
workerPid	integer, null

`channel`

Type: string, null
Default value: null
Since: 3.4.0

The channel column value to the queue should use. If null, the queue’s application component ID will be used.

View source

`commandClass`

Type: string
Default value: \craft\queue\Command::class

Command class name

View source

`db`

Type: craft\db\Connection, array, string
Default value: 'db'
Since: 3.4.0

The database connection to use

View source

`hasReservedJobs`

Type: boolean
Default value: null
Access: Read-only

View source

`hasWaitingJobs`

Type: boolean
Default value: null
Access: Read-only

View source

`jobId`

Type: string
Default value: null
Access: Read-only
Since: 4.10.0

View source

`jobInfo`

Type: array
Default value: null
Access: Read-only

View source

`mutex`

Type: yii\mutex\Mutex, array, string
Default value: 'mutex'
Since: 3.4.0

The mutex component to use

View source

`mutexTimeout`

Type: integer
Default value: 5

The time (in seconds) to wait for mutex locks to be released when attempting to reserve new jobs.

View source

`progress`

Type: integer
Default value: null
Access: Write-only

The job progress (1-100)

View source

`proxyQueue`

Type: yii\queue\Queue, array, string, null
Default value: null
Since: 4.0.0

An external queue that proxy jobs should be sent to.

If this is set, push() will send craft\queue\jobs\Proxy jobs to it that reference the internal job IDs. When executed, those jobs will cause the referenced internal jobs to be executed, unless they’ve already been run directly.

View source

`tableName`

Type: string
Default value: \craft\db\Table::QUEUE
Since: 3.4.0

The table name the queue is stored in.

View source

`totalDelayed`

Type: integer
Default value: null
Access: Read-only

View source

`totalFailed`

Type: integer
Default value: null
Access: Read-only

View source

`totalJobs`

Type: integer
Default value: null
Access: Read-only
Since: 3.4.0

View source

`totalReserved`

Type: integer
Default value: null
Access: Read-only

View source

`totalWaiting`

Type: integer
Default value: null
Access: Read-only

View source

Public Methods

Method	Description
__call()	Calls the named method which is not a class method.
__clone()	This method is called after the object is created by cloning an existing one.
__construct()	Constructor.
__get()	Returns the value of a component property.
__isset()	Checks if a property is set, i.e. defined and not null.
__set()	Sets the value of a component property.
__unset()	Sets a component property to be null.
attachBehavior()	Attaches a behavior to this component.
attachBehaviors()	Attaches a list of behaviors to the component.
behaviors()	Returns a list of behaviors that this component should behave as.
bootstrap()	Bootstrap method to be called during application bootstrap stage.
canGetProperty()	Returns a value indicating whether a property can be read.
canSetProperty()	Returns a value indicating whether a property can be set.
className()	Returns the fully qualified name of this class.
delay()	Sets delay for later execute.
detachBehavior()	Detaches a behavior from the component.
detachBehaviors()	Detaches all behaviors from the component.
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.
executeJob()	Executes a single job.
getBehavior()	Returns the named behavior object.
getBehaviors()	Returns all behaviors attached to this component.
getHasReservedJobs()	Returns whether there are any reserved jobs.
getHasWaitingJobs()	Returns whether there are any waiting jobs.
getJobDetails()	Returns detailed info about a single job.
getJobId()	Returns the ID of the current job being handled.
getJobInfo()	Returns info about the jobs in the queue.
getTotalDelayed()	Returns the total number of delayed jobs
getTotalFailed()	Returns the total number of failed jobs
getTotalJobs()	Returns the total number of jobs in the queue.
getTotalReserved()	Returns the total number of reserved jobs
getTotalWaiting()	Returns the total number of waiting jobs
getWorkerPid()	Gets process ID of a worker.
handleError()
handleResponse()	Figure out how to initiate a new worker.
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.
hasMethod()	Returns a value indicating whether a method is defined.
hasProperty()	Returns a value indicating whether a property is defined for this component.
init()	Initializes the object.
isDone()
isFailed()
isReserved()
isWaiting()
listen()	Listens to the queue and runs new jobs.
off()	Detaches an existing event handler from this component.
on()	Attaches an event handler to an event.
priority()	Sets job priority.
push()	Pushes job into queue.
release()
releaseAll()
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.
status()
trigger()	Triggers an event.
ttr()	Sets TTR for job execute.
unserializeMessage()	Unserializes.

`executeJob()`

Executes a single job.

View source

Arguments

$id (string, null) – The job ID, if a specific job should be run

Returns

boolean – Whether a job was found

`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)
progressLabel – the progress label (lazy-translated with craft\i18n\Translation::translate())
description – the job description (lazy-translated with craft\i18n\Translation::translate())
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

$id (string)

Returns

array

Throws

yii\base\InvalidArgumentException
if $id is an invalid job ID

`getJobId()`

Since: 4.10.0

Returns the ID of the current job being handled.

View source

Returns

string

`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)
progressLabel – the progress label (lazy-translated with craft\i18n\Translation::translate())
description – the job description (lazy-translated with craft\i18n\Translation::translate())
error – the error message (if the job failed)

View source