Class craft\queue\jobs\UpdateElementSlugsAndUris

Inheritance: craft\queue\jobs\UpdateElementSlugsAndUris » craft\queue\BaseJob » yii\base\BaseObject
Implements: craft\queue\JobInterface, yii\base\Configurable
Available since version: 3.0
Source Code: https://github.com/craftcms/cms/blob/master/src/queue/jobs/UpdateElementSlugsAndUris.php

UpdateElementSlugsAndUris job

Public Properties
Property	Type	Description	Defined By
`$description`	string, null	The configured job description	craft\queue\BaseJob
`$elementId`	integer, integer[], null	The ID(s) of the element(s) to update	craft\queue\jobs\UpdateElementSlugsAndUris
`$elementType`	string, craft\base\ElementInterface, null	The type of elements to update.	craft\queue\jobs\UpdateElementSlugsAndUris
`$siteId`	integer, null	The site ID of the elements to update.	craft\queue\jobs\UpdateElementSlugsAndUris
`$updateDescendants`	boolean	Whether the elements’ descendants should be updated as well.	craft\queue\jobs\UpdateElementSlugsAndUris
`$updateOtherSites`	boolean	Whether the elements’ other sites should be updated as well.	craft\queue\jobs\UpdateElementSlugsAndUris

Public Methods
Method	Description	Defined By
`__call()`	Calls the named method which is not a class method.	yii\base\BaseObject
`__construct()`	Constructor.	yii\base\BaseObject
`__get()`	Returns the value of an object property.	yii\base\BaseObject
`__isset()`	Checks if a property is set, i.e. defined and not null.	yii\base\BaseObject
`__set()`	Sets value of an object property.	yii\base\BaseObject
`__unset()`	Sets an object property to null.	yii\base\BaseObject
`canGetProperty()`	Returns a value indicating whether a property can be read.	yii\base\BaseObject
`canSetProperty()`	Returns a value indicating whether a property can be set.	yii\base\BaseObject
`className()`	Returns the fully qualified name of this class.	yii\base\BaseObject
`execute()`		craft\queue\jobs\UpdateElementSlugsAndUris
`getDescription()`	Returns the description that should be used for the job.	craft\queue\BaseJob
`hasMethod()`	Returns a value indicating whether a method is defined.	yii\base\BaseObject
`hasProperty()`	Returns a value indicating whether a property is defined.	yii\base\BaseObject
`init()`	Initializes the object.	craft\queue\BaseJob

Protected Methods
Method	Description	Defined By
`defaultDescription()`	Returns a default description for getDescription().	craft\queue\jobs\UpdateElementSlugsAndUris
`setProgress()`	Sets the job progress on the queue.	craft\queue\BaseJob

Property Details

The ID(s) of the element(s) to update

public integer, integer[], null $elementId = null

The type of elements to update.

public string, craft\base\ElementInterface, null $elementType = null

The site ID of the elements to update.

public integer, null $siteId = null

Whether the elements’ descendants should be updated as well.

public boolean $updateDescendants = true

Whether the elements’ other sites should be updated as well.

public boolean $updateOtherSites = true

Returns a default description for getDescription().

protected string, null defaultDescription ( )

public void execute ( $queue )

$queue \yii\queue\Queue, craft\queue\QueueInterface The queue the job belongs to