Skip to content

BaseBatchedElementJob

Type
Abstract Class
Namespace
craft\queue
Inherits
craft\queue\BaseBatchedElementJob » craft\queue\BaseBatchedJob » craft\queue\BaseJob » yii\base\BaseObject
Implements
craft\queue\JobInterface, yii\base\Configurable
Extended by
craft\queue\jobs\ApplyNewPropagationMethod, craft\queue\jobs\PropagateElements, craft\queue\jobs\ResaveElements
Since
5.0.0

BaseBatchedElementJob is the base class for large jobs that may need to spawn additional jobs to complete the workload, which perform actions on elements.

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
descriptionstring, null – The configured job description.
itemOffsetinteger – The offset to start fetching items by.
priorityinteger, null – The job’s priority
ttrinteger, null – The job’s TTR

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.

after()

Since
5.0.0

Does things after the last item of the last batch.

View source

before()

Since
5.0.0

Does things before the first item of the first batch.

View source

beforeBatch()

Since
5.0.0

Does things before the first item of the current batch.

View source