JobInterface

Type
Interface
Namespace
craft\queue
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\PropagateElements, craft\queue\jobs\ResaveElements, craft\queue\jobs\UpdateElementSlugsAndUris
Since
3.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.

View source

Public Methods

MethodDescription
execute()
getDescription()Returns the description that should be used for the job.

execute()

View source

Arguments

Signature

public abstract void execute ( $queue )

getDescription()

Returns the description that should be used for the job.

View source

Returns

string, null

Signature

public abstract string, null getDescription ( )