ResaveElements

Type
Class
Namespace
craft\queue\jobs
Inherits
craft\queue\jobs\ResaveElements » craft\queue\BaseJob » yii\base\BaseObject
Implements
craft\queue\JobInterface, yii\base\Configurable
Since
3.0.0

ResaveElements job

View source

# Public Properties

Property Description
criteria array, null – The element criteria that determines which elements should be resaved
description string, null – The configured job description
elementType string, craft\base\ElementInterface, null – The element type that should be resaved
updateSearchIndex boolean – Whether to update the search indexes for the resaved elements.

# criteria

Type
array, null

The element criteria that determines which elements should be resaved

View source

# elementType

Type
string, craft\base\ElementInterface, null

The element type that should be resaved

View source

# updateSearchIndex

Type
boolean
Since
3.4.2

Whether to update the search indexes for the resaved elements.

View source

# Public Methods

Method Description
__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.

# execute()

View source

Arguments

# Protected Methods

Method Description
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