Skip to content

PropagateElements

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

PropagateElements 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 propagated
descriptionstring, null – The configured job description.
elementTypestring – The element type that should be propagated
itemOffsetinteger – The offset to start fetching items by.
priorityinteger, null – The job’s priority
siteIdinteger, integer[], null – The site ID(s) that the elements should be propagated to If this is null, then elements will be propagated to all supported sites, except the one they were queried in.
ttrinteger, null – The job’s TTR

criteria

Type
array, null
Default value
null

The element criteria that determines which elements should be propagated

View source

elementType

Type
string
Default value
null

The element type that should be propagated

View source

siteId

Type
integer, integer[], null
Default value
null

The site ID(s) that the elements should be propagated to

If this is null, then elements will be propagated to all supported sites, except the one they were queried in.

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.

init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source

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)