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
Public Properties ​
| Property | Description |
|---|---|
| batchIndex | integer – The index of the current batch (starting with 0) |
| batchSize | integer – The number of items that should be processed in a single batch |
| criteria | array, null – The element criteria that determines which elements should be propagated |
| description | string, null – The configured job description. |
| elementType | class-string<\craft\base\ElementInterface> – The element type that should be propagated |
| itemOffset | integer – The offset to start fetching items by. |
| priority | integer, null – The job’s priority |
| siteId | integer, 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. |
| ttr | integer, null – The job’s TTR |
criteria ​
The element criteria that determines which elements should be propagated
elementType ​
- Type
class-string<\craft\base\ElementInterface>- Default value
null
The element type that should be propagated
siteId ​
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.
Public Methods ​
| Method | Description |
|---|---|
| __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.
Protected Methods ​
| Method | Description |
|---|---|
| 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.
Returns ​
loadData() ​
Loads the batchable data.
Returns ​
processItem() ​
Processes an item.
Arguments ​
$item(mixed)