UpdateSearchIndex
- Type
- Class
- Namespace
- craft\queue\jobs
- Inherits
- craft\queue\jobs\UpdateSearchIndex » craft\queue\BaseJob » yii\base\BaseObject (opens new window)
- Implements
- craft\queue\JobInterface, yii\base\Configurable (opens new window)
- Since
- 3.2.0
UpdateSearchIndex job
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| description | string (opens new window), null (opens new window) – The configured job description. |
| elementId | integer (opens new window), integer (opens new window)[], null (opens new window) – The ID(s) of the element(s) to update |
| elementType | string (opens new window) – The type of elements to update. |
| fieldHandles | string (opens new window)[], null (opens new window) – The field handles that should be indexed |
| siteId | integer (opens new window), string (opens new window), null (opens new window) – The site ID of the elements to update, or '*' to update all sites |
# elementId
- Type
- integer (opens new window), integer (opens new window)[], null (opens new window)
- Default value
null
The ID(s) of the element(s) to update
View source (opens new window)
# elementType
- Type
- string (opens new window)
- Default value
null
The type of elements to update.
View source (opens new window)
# fieldHandles
- Type
- string (opens new window)[], null (opens new window)
- Default value
null- Since
- 3.4.0
The field handles that should be indexed
View source (opens new window)
# siteId
- Type
- integer (opens new window), string (opens new window), null (opens new window)
- Default value
'*'
The site ID of the elements to update, or '*' to update all sites
View source (opens new window)
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __construct() (opens new window) | Constructor. |
| __get() (opens new window) | Returns the value of an object property. |
| __isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
| __set() (opens new window) | Sets value of an object property. |
| __unset() (opens new window) | Sets an object property to null. |
| __wakeup() | |
| canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
| canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
| className() (opens new window) | Returns the fully qualified name of this class. |
| execute() | |
| getDescription() | Returns the description that should be used for the job. |
| hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
| hasProperty() (opens new window) | Returns a value indicating whether a property is defined. |
| init() | Initializes the object. |
# execute()
View source (opens new window)
Arguments
$queue(yii\queue\Queue (opens new window), craft\queue\QueueInterface) – The queue the job belongs to
# 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().
TIP
Run the description through craft\i18n\Translation::prep() rather than Craft::t() (opens new window) so it can be lazy-translated for users’ preferred languages rather that the current app language.
View source (opens new window)