You are here

public function SearchApiExternalDataSourceController::getIndexStatus in Search API 7

Get 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 the index doesn't use the same item type as this controller.

Overrides SearchApiAbstractDataSourceController::getIndexStatus

File

includes/datasource_external.inc, line 252
Contains the SearchApiExternalDataSourceController class.

Class

SearchApiExternalDataSourceController
Base class for data source controllers for external data sources.

Code

public function getIndexStatus(SearchApiIndex $index) {
  return array(
    'indexed' => 0,
    'total' => 0,
  );
}