Craft 3 Class Reference

Class craft\queue\jobs\ResaveElements

Inheritance
craft\queue\jobs\ResaveElements » craft\queue\BaseJob » yii\base\BaseObject
Implements
craft\queue\JobInterface, yii\base\Configurable
Available since version
3.0
Source Code
https://github.com/craftcms/cms/blob/master/src/queue/jobs/ResaveElements.php

ResaveElements job

Public Properties
Property Type Description Defined By
$criteria array, null The element criteria that determines which elements should be resaved craft\queue\jobs\ResaveElements
$description string, null The configured job description craft\queue\BaseJob
$elementType string, craft\base\ElementInterface, null The element type that should be resaved craft\queue\jobs\ResaveElements
Public Methods
Method Description Defined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of an object property. yii\base\BaseObject
__isset() Checks if a property is set, i.e. defined and not null. yii\base\BaseObject
__set() Sets value of an object property. yii\base\BaseObject
__unset() Sets an object property to null. yii\base\BaseObject
canGetProperty() Returns a value indicating whether a property can be read. yii\base\BaseObject
canSetProperty() Returns a value indicating whether a property can be set. yii\base\BaseObject
className() Returns the fully qualified name of this class. yii\base\BaseObject
execute() craft\queue\jobs\ResaveElements
getDescription() Returns the description that should be used for the job. craft\queue\BaseJob
hasMethod() Returns a value indicating whether a method is defined. yii\base\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
init() Initializes the object. craft\queue\BaseJob
Protected Methods
Method Description Defined By
defaultDescription() Returns a default description for getDescription(). craft\queue\jobs\ResaveElements
setProgress() Sets the job progress on the queue. craft\queue\BaseJob

Property Details

$criteria public property #

The element criteria that determines which elements should be resaved

public array, null $criteria null

$elementType public property #

The element type that should be resaved

public string, craft\base\ElementInterface, null $elementType null

Method Details

defaultDescription() protected method #

Returns a default description for getDescription().

protected string, null defaultDescription ( )

execute() public method #

public void execute ( $queue )
$queue \yii\queue\Queue, craft\queue\QueueInterface The queue the job belongs to