You are here

public function SearchApiDataSourceControllerInterface::trackItemChange in Search API 7

Sets the tracking status of the given items to "changed"/"dirty".

Unless $dequeue is set to TRUE, this operation is ignored for items whose status is not "indexed".

Parameters

array|false $item_ids: Either an array with the IDs of the changed items. Or FALSE to mark all items as changed for the given indexes.

SearchApiIndex[] $indexes: The indexes for which the change should be tracked.

bool $dequeue: (deprecated) If set to TRUE, also change the status of queued items. The concept of queued items will be removed in the Drupal 8 version of this module.

Return value

SearchApiIndex[]|null All indexes for which any items were updated; or NULL if items were updated for all of them.

Throws

SearchApiDataSourceException If any error state was encountered.

1 method overrides SearchApiDataSourceControllerInterface::trackItemChange()
SearchApiAbstractDataSourceController::trackItemChange in includes/datasource.inc
Sets the tracking status of the given items to "changed"/"dirty".

File

includes/datasource.inc, line 193
Contains the SearchApiDataSourceControllerInterface as well as a default base class.

Class

SearchApiDataSourceControllerInterface
Interface for all data source controllers for Search API indexes.

Code

public function trackItemChange($item_ids, array $indexes, $dequeue = FALSE);