BaseJob ​
- Type
- Abstract Class
- Namespace
- craft\queue
- Inherits
- craft\queue\BaseJob » yii\base\BaseObject
- Implements
- craft\queue\JobInterface, yii\base\Configurable
- Extended by
- craft\queue\BaseBatchedJob, craft\queue\jobs\Announcement, craft\queue\jobs\ApplyNewPropagationMethod, craft\queue\jobs\FindAndReplace, craft\queue\jobs\GenerateImageTransform, craft\queue\jobs\GeneratePendingTransforms, craft\queue\jobs\LocalizeRelations, craft\queue\jobs\PropagateElements, craft\queue\jobs\Proxy, 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.
Public Properties ​
| Property | Description |
|---|---|
| description | string, null – The configured job description. |
description ​
The configured job description.
TIP
Run the description through craft\i18n\Translation::prep() rather than Craft::t() so it can be lazy-translated for users’ preferred languages rather that the current app language.
Public Methods ​
| Method | Description |
|---|---|
| __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. |
__wakeup() ​
getDescription() ​
Returns the description that should be used for the job.
Returns ​
init() ​
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
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().
TIP
Run the description through craft\i18n\Translation::prep() rather than Craft::t() so it can be lazy-translated for users’ preferred languages rather that the current app language.
Returns ​
setProgress() ​
Sets the job progress on the queue.
TIP
Run the label through craft\i18n\Translation::prep() rather than Craft::t() so it can be lazy-translated for users’ preferred languages rather that the current app language.
Arguments ​
$queue(yii\queue\Queue, craft\queue\QueueInterface)$progress(float) – A number between 0 and 1$label(string, null) – The progress label