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\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

Job is the base class for classes representing jobs in terms of objects.

View source

Public Properties

PropertyDescription
$descriptionstring, null – The configured job description

$description

Type
string, null
Access
Read-only

The configured job description

View source

Signature

public string, null getDescription ( )

Public Methods

MethodDescription
__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.
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.

getDescription()

Returns the description that should be used for the job.

View source

Returns

string, null

Signature

public string, null getDescription ( )

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

Signature

public void init ( )

Protected Methods

MethodDescription
defaultDescription()Returns a default description for getDescription().
setProgress()Sets the job progress on the queue.

defaultDescription()

Returns a default description for getDescription().

View source

Returns

string, null

Signature

protected string, null defaultDescription ( )

setProgress()

Sets the job progress on the queue.

View source

Arguments

Signature

protected void setProgress ( $queue, \craft\queue\float $progress )