Skip to content

ApplyNewPropagationMethod

Type
Class
Namespace
craft\queue\jobs
Inherits
craft\queue\jobs\ApplyNewPropagationMethod » craft\queue\BaseBatchedJob » craft\queue\BaseJob » yii\base\BaseObject
Implements
craft\queue\JobInterface, yii\base\Configurable
Since
3.4.8

ApplyNewPropagationMethod loads all elements that match a given criteria, and resaves them to apply a new propagation method to them, duplicating them for any sites where they would have been deleted in the process.

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 the new propagation method should be applied to
descriptionstring, null – The configured job description.
elementTypestring – The element type to use
itemOffsetinteger – The offset to start fetching items by.
priorityinteger, null – The job’s priority
ttrinteger, null – The job’s TTR

criteria

Type
array, null
Default value
null

The element criteria that determines which elements the new propagation method should be applied to

View source

elementType

Type
string
Default value
null

The element type to use

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
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)