ResaveElements

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

ResaveElements job

View source (opens new window)

# Public Properties

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

# criteria

Type
array (opens new window), null (opens new window)
Default value
null

The element criteria that determines which elements should be resaved

View source (opens new window)

# elementType

Type
string (opens new window), craft\base\ElementInterface, null (opens new window)
Default value
null

The element type that should be resaved

View source (opens new window)

# updateSearchIndex

Type
boolean (opens new window)
Default value
false
Since
3.4.2

Whether to update the search indexes for the resaved elements.

View source (opens new window)

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__construct() (opens new window) Constructor.
__get() (opens new window) Returns the value of an object property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets value of an object property.
__unset() (opens new window) Sets an object property to null.
canGetProperty() (opens new window) Returns a value indicating whether a property can be read.
canSetProperty() (opens new window) Returns a value indicating whether a property can be set.
className() (opens new window) Returns the fully qualified name of this class.
execute()
getDescription() Returns the description that should be used for the job.
hasMethod() (opens new window) Returns a value indicating whether a method is defined.
hasProperty() (opens new window) Returns a value indicating whether a property is defined.
init() Initializes the object.

# execute()

View source (opens new window)

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 (opens new window)

Returns

string (opens new window), null (opens new window)