BaseJob
- Type
- Abstract Class
- Namespace
- craft\queue
- Inherits
- craft\queue\BaseJob » yii\base\BaseObject (opens new window)
- Implements
- craft\queue\JobInterface, yii\base\Configurable (opens new window)
- Extended by
- craft\queue\jobs\Announcement, craft\queue\jobs\ApplyMatrixPropagationMethod, craft\queue\jobs\ApplyNewPropagationMethod, craft\queue\jobs\ConvertEntryRevisions, craft\queue\jobs\DeleteStaleTemplateCaches, craft\queue\jobs\FindAndReplace, craft\queue\jobs\GeneratePendingTransforms, craft\queue\jobs\LocalizeRelations, craft\queue\jobs\PropagateElements, craft\queue\jobs\PruneRevisions, craft\queue\jobs\ResaveElements, craft\queue\jobs\UpdateElementSlugsAndUris, craft\queue\jobs\UpdateSearchIndex
- Since
- 3.0.0
Job is the base class for classes representing jobs in terms of objects.
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| description | string (opens new window), null (opens new window) – The configured job description |
# description
- Type
- string (opens new window), null (opens new window)
- Default value
null
The configured job description
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. |
# getDescription()
Returns the description that should be used for the job.
View source (opens new window)
Returns
string (opens new window), null (opens new window)
# init()
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
View source (opens new window)
# Protected Methods
| Method | Description |
|---|---|
| defaultDescription() | Returns a default description for getDescription(). |
| setProgress() | Sets the job progress on the queue. |
# defaultDescription()
Returns a default description for getDescription().
View source (opens new window)
Returns
string (opens new window), null (opens new window)
# setProgress()
Sets the job progress on the queue.
View source (opens new window)
Arguments
$queue(yii\queue\Queue (opens new window), craft\queue\QueueInterface)$progress(float (opens new window)) – A number between 0 and 1$label(string (opens new window), null (opens new window)) – The progress label