PropagateElements

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

PropagateElements job

View source

Public Properties

PropertyDescription
$criteriaarray, null – The element criteria that determines which elements should be propagated
$descriptionstring, null – The configured job description
$elementTypestring, craft\base\ElementInterface – The element type that should be propagated
$siteIdinteger, integer[] – The site ID(s) that the elements should be propagated to

$criteria

Type
array, null

The element criteria that determines which elements should be propagated

View source

Signature

public array, null $criteria = null

$elementType

Type
string, craft\base\ElementInterface

The element type that should be propagated

View source

Signature

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

$siteId

Type
integer, integer[]

The site ID(s) that the elements should be propagated to

View source

Signature

public integer, integer[] $siteId = null

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 ( )