ResaveElements

Type
Class
Namespace
craft\queue\jobs
Inherits
craft\queue\jobs\ResaveElements » craft\queue\BaseBatchedJob » 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
batchIndex integer (opens new window) – The index of the current batch (starting with 0)
batchSize integer (opens new window) – The number of items that should be processed in a single batch
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) – The element type that should be resaved
ifEmpty boolean (opens new window) – Whether the set attribute should only be set if it doesn’t have a value.
itemOffset integer (opens new window) – The offset to start fetching items by.
priority integer (opens new window), null (opens new window) – The job’s priority
set string (opens new window), null (opens new window) – An attribute name that should be set for each of the elements.
to string (opens new window), null (opens new window) – The value that should be set on the set attribute.
touch boolean (opens new window) – Whether to update the dateUpdated timestamp for the elements.
ttr integer (opens new window), null (opens new window) – The job’s TTR
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)
Default value
null

The element type that should be resaved

View source (opens new window)

# ifEmpty

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

Whether the set attribute should only be set if it doesn’t have a value.

View source (opens new window)

# set

Type
string (opens new window), null (opens new window)
Default value
null
Since
4.2.6

An attribute name that should be set for each of the elements. The value will be determined by to.

View source (opens new window)

# to

Type
string (opens new window), null (opens new window)
Default value
null
Since
4.2.6

The value that should be set on the set attribute.

View source (opens new window)

# touch

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

Whether to update the dateUpdated timestamp for the elements.

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.
__sleep()
__unset() (opens new window) Sets an object property to null.
__wakeup()
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.

# Protected Methods

Method Description
data() Returns the batchable data.
defaultDescription() Returns a default description for getDescription().
loadData() Loads the batchable data.
processItem() Processes an item.
setProgress() Sets the job progress on the queue.
totalBatches() Returns the total number of batches.
totalItems() Returns the total number of items across all the batches.

# defaultDescription()

Returns a default description for getDescription().

TIP

Run the description through craft\i18n\Translation::prep() rather than Craft::t() (opens new window) so it can be lazy-translated for users’ preferred languages rather that the current app language.

View source (opens new window)

Returns

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

# loadData()

Loads the batchable data.

View source (opens new window)

Returns

craft\base\Batchable

# processItem()

Processes an item.

View source (opens new window)

Arguments

  • $item (mixed)