Proxy

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

Proxy job

View source (opens new window)

# Public Properties

Property Description
description string (opens new window), null (opens new window) – The configured job description.
jobId string (opens new window) – The internal job’s ID.
queue string (opens new window) – The internal queue’s application component ID.

# jobId

Type
string (opens new window)
Default value
null

The internal job’s ID.

View source (opens new window)

# queue

Type
string (opens new window)
Default value
null

The internal queue’s application component ID.

View source (opens new window)

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__construct() (opens new window) Constructor.
__get() (opens new window) Returns the value of an object property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets value of an object property.
__unset() (opens new window) Sets an object property to null.
canGetProperty() (opens new window) Returns a value indicating whether a property can be read.
canSetProperty() (opens new window) Returns a value indicating whether a property can be set.
className() (opens new window) Returns the fully qualified name of this class.
execute()
getDescription() Returns the description that should be used for the job.
hasMethod() (opens new window) Returns a value indicating whether a method is defined.
hasProperty() (opens new window) Returns a value indicating whether a property is defined.
init() Initializes the object.

# execute()

View source (opens new window)

Arguments

Throws

# Protected Methods

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