Interface craft\queue\JobInterface
- Extends
- yii\queue\JobInterface
- Implemented by
- craft\queue\BaseJob, craft\queue\jobs\DeleteStaleTemplateCaches, craft\queue\jobs\FindAndReplace, craft\queue\jobs\GeneratePendingTransforms, craft\queue\jobs\LocalizeRelations, craft\queue\jobs\ResaveElements, craft\queue\jobs\UpdateElementSlugsAndUris
- Available since version
- 3.0
- Source Code
- https://github.com/craftcms/cms/blob/master/src/queue/JobInterface.php
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.
| Method | Description | Defined By |
|---|---|---|
execute() |
craft\queue\JobInterface | |
getDescription() |
Returns the description that should be used for the job. | craft\queue\JobInterface |
Method Details
execute()
public abstract method
#
public abstract void execute ( $queue )$queue |
\yii\queue\Queue, craft\queue\QueueInterface | The queue the job belongs to |
getDescription()
public abstract method
#
Returns the description that should be used for the job.
public abstract string, null getDescription ( )