UpdateSearchIndex

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

UpdateSearchIndex job

View source

# Public Properties

Property Description
description string, null – The configured job description
elementId integer, integer[], null – The ID(s) of the element(s) to update
elementType string, craft\base\ElementInterface, null – The type of elements to update.
fieldHandles string[], null – The field handles that should be indexed
siteId integer, string, null – The site ID of the elements to update, or '*' to update all sites

# elementId

Type
integer, integer[], null

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

View source

# elementType

Type
string, craft\base\ElementInterface, null

The type of elements to update.

View source

# fieldHandles

Type
string[], null
Since
3.4.0

The field handles that should be indexed

View source

# siteId

Type
integer, string, null

The site ID of the elements to update, or '*' to update all sites

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.
__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

# Protected Methods

Method Description
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