PropagateElements
- Type
- Class
- Namespace
- craft\queue\jobs
- Inherits
- craft\queue\jobs\PropagateElements » 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.13
PropagateElements 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 propagated |
| description | string (opens new window), null (opens new window) – The configured job description. |
| elementType | string (opens new window) – The element type that should be propagated |
| 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 |
| siteId | integer (opens new window), integer (opens new window)[], null (opens new window) – 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. |
| ttr | integer (opens new window), null (opens new window) – The job’s TTR |
# criteria
- Type
- array (opens new window), null (opens new window)
- Default value
null
The element criteria that determines which elements should be propagated
View source (opens new window)
# elementType
- Type
- string (opens new window)
- Default value
null
The element type that should be propagated
View source (opens new window)
# siteId
- Type
- integer (opens new window), integer (opens new window)[], null (opens new window)
- 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 (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. |
# 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 (opens new window)
# 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
# processItem()
Processes an item.
View source (opens new window)
Arguments
$item(mixed)