public function SearchApiDataSourceControllerInterface::getIndexStatus in Search API 7

Retrieves information on how many items have been indexed for a certain index.

Parameters

SearchApiIndex $index: The index whose index status should be returned.

Return value

array An associative array containing two keys (in this order):

• indexed: The number of items already indexed in their latest version.
• total: The total number of items that have to be indexed for this index.

Throws

SearchApiDataSourceException If any error state was encountered.

1 method overrides SearchApiDataSourceControllerInterface::getIndexStatus()

SearchApiAbstractDataSourceController::getIndexStatus in includes/datasource.inc

Retrieves information on how many items have been indexed for a certain index.

File

includes/datasource.inc, line 282

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 getIndexStatus(SearchApiIndex $index);