Skip to content

Proxy

Type
Class
Namespace
craft\queue\jobs
Inherits
craft\queue\jobs\Proxy » craft\queue\BaseJob » yii\base\BaseObject
Implements
craft\queue\JobInterface, yii\base\Configurable
Since
4.0.0

Proxy job

View source

Public Properties

PropertyDescription
descriptionstring, null – The configured job description.
jobIdstring – The internal job’s ID.
queuestring – The internal queue’s application component ID.

jobId

Type
string
Default value
null

The internal job’s ID.

View source

queue

Type
string
Default value
null

The internal queue’s application component ID.

View source

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to null.
__wakeup()
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.
execute()
getDescription()Returns the description that should be used for the job.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the object.

execute()

View source

Arguments

Throws

Protected Methods

MethodDescription
defaultDescription()Returns a default description for getDescription().
setProgress()Sets the job progress on the queue.