Skip to content

ResaveElements

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

ResaveElements job

View source

Public Properties

PropertyDescription
batchIndexinteger – The index of the current batch (starting with 0)
batchSizeinteger – The number of items that should be processed in a single batch
criteriaarray, null – The element criteria that determines which elements should be resaved
descriptionstring, null – The configured job description.
elementTypestring – The element type that should be resaved
ifEmptyboolean – Whether the set attribute should only be set if it doesn’t have a value.
ifInvalidboolean – Whether the set attribute should only be set if the current value doesn’t validate.
itemOffsetinteger – The offset to start fetching items by.
priorityinteger, null – The job’s priority
setstring, null – An attribute name that should be set for each of the elements.
tostring, null – The value that should be set on the set attribute.
touchboolean – Whether to update the dateUpdated timestamp for the elements.
ttrinteger, null – The job’s TTR
updateSearchIndexboolean – Whether to update the search indexes for the resaved elements.

criteria

Type
array, null
Default value
null

The element criteria that determines which elements should be resaved

View source

elementType

Type
string
Default value
null

The element type that should be resaved

View source

ifEmpty

Type
boolean
Default value
false
Since
4.2.6

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

View source

ifInvalid

Type
boolean
Default value
false
Since
4.9.0

Whether the set attribute should only be set if the current value doesn’t validate.

View source

set

Type
string, null
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

to

Type
string, null
Default value
null
Since
4.2.6

The value that should be set on the set attribute.

View source

touch

Type
boolean
Default value
false
Since
4.2.6

Whether to update the dateUpdated timestamp for the elements.

View source

updateSearchIndex

Type
boolean
Default value
false
Since
3.4.2

Whether to update the search indexes for the resaved elements.

View source

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

Protected Methods

MethodDescription
after()Does things after the last item of the last batch.
afterBatch()Does things after the last item of the current batch.
before()Does things before the first item of the first batch.
beforeBatch()Does things before the first item of the current batch.
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() so it can be lazy-translated for users’ preferred languages rather that the current app language.

View source

Returns

string, null

loadData()

Loads the batchable data.

View source

Returns

craft\base\Batchable

processItem()

Processes an item.

View source

Arguments

  • $item (mixed)