JobInterface ​
- Type
- Interface
- Namespace
- craft\queue
- Extends
- yii\queue\JobInterface
- Implemented by
- craft\queue\BaseJob, 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
JobInterface defines the common interface to be implemented by job classes.
A class implementing this interface should also use \craft\queue\SavableComponentTrait and \craft\queue\JobTrait.
Public Methods ​
| Method | Description |
|---|---|
| execute() | |
| getDescription() | Returns the description that should be used for the job. |
execute() ​
Arguments ​
$queue(yii\queue\Queue, craft\queue\QueueInterface) – The queue the job belongs to
getDescription() ​
Returns the description that should be used for the job.