UpdateElementSlugsAndUris

Type
Class
Namespace
craft\queue\jobs
Inherits
craft\queue\jobs\UpdateElementSlugsAndUris » craft\queue\BaseJob » yii\base\BaseObject
Implements
craft\queue\JobInterface, yii\base\Configurable
Since
3.0

UpdateElementSlugsAndUris job

View source

Public Properties

PropertyDescription
$descriptionstring, null – The configured job description
$elementIdinteger, integer[], null – The ID(s) of the element(s) to update
$elementTypestring, craft\base\ElementInterface, null – The type of elements to update.
$siteIdinteger, null – The site ID of the elements to update.
$updateDescendantsboolean – Whether the elements’ descendants should be updated as well.
$updateOtherSitesboolean – Whether the elements’ other sites should be updated as well.

$elementId

Type
integer, integer[], null

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

View source

Signature

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

$elementType

Type
string, craft\base\ElementInterface, null

The type of elements to update.

View source

Signature

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

$siteId

Type
integer, null

The site ID of the elements to update.

View source

Signature

public integer, null $siteId = null

$updateDescendants

Type
boolean

Whether the elements’ descendants should be updated as well.

View source

Signature

public boolean $updateDescendants = true

$updateOtherSites

Type
boolean

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

View source

Signature

public boolean $updateOtherSites = true

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.
__unset()Sets an object property to null.
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.

execute()

View source

Arguments

Signature

public void execute ( $queue )

Protected Methods

MethodDescription
defaultDescription()Returns a default description for getDescription().
setProgress()Sets the job progress on the queue.

defaultDescription()

Returns a default description for getDescription().

View source

Returns

string, null

Signature

protected string, null defaultDescription ( )