Skip to content

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

PropertyDescription
descriptionstring, null – The configured job description.
elementIdinteger, integer[], null – The ID(s) of the element(s) to update
elementTypestring – The type of elements to update.
fieldHandlesstring[], null – The field handles that should be indexed
siteIdinteger, string, null – The site ID of the elements to update, or '*' to update all sites

elementId

Type
integer, integer[], null
Default value
null

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

View source

elementType

Type
string
Default value
null

The type of elements to update.

View source

fieldHandles

Type
string[], null
Default value
null
Since
3.4.0

The field handles that should be indexed

View source

siteId

Type
integer, string, null
Default value
'*'

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

View source

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

execute()

View source

Arguments

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

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