ReplaceRelations

Type

Class

Namespace

craft\queue\jobs

Inherits

craft\queue\jobs\ReplaceRelations » craft\queue\BaseBatchedElementJob » craft\queue\BaseBatchedJob » craft\queue\BaseJob » yii\base\BaseObject

Implements

craft\queue\JobInterface, yii\base\Configurable

Since

5.10.0

ReplaceRelations job

View source

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
description	string, null – The configured job description.
itemOffset	integer – The offset to start fetching items by.
newTargetId	integer – The element ID to use as a replacement
oldTargetIds	integer[] – The element IDs to replace
priority	integer, null – The job’s priority
sourceElementType	class-string<\craft\base\ElementInterface> – The element type that contains the relations
sourceIds	integer[] – The source element IDs to update
targetElementType	class-string<\craft\base\ElementInterface> – The element type that is being related
ttr	integer, null – The job’s TTR

newTargetId

Type

integer

Default value

null

The element ID to use as a replacement

View source

oldTargetIds

Type

integer[]

Default value

null

The element IDs to replace

View source

sourceElementType

Type

class-string<\craft\base\ElementInterface>

Default value

null

The element type that contains the relations

View source

sourceIds

Type

integer[]

Default value

null

The source element IDs to update

View source

targetElementType

Type

class-string<\craft\base\ElementInterface>

Default value

null

The element type that is being related

View source

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.

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.

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)