You are here

public function SearchApiCombinedEntityDataSourceController::getIdFieldInfo in Search API 7

Returns information on the ID field for this controller's type.

Return value

array An associative array containing the following keys:

  • key: The property key for the ID field, as used in the item wrapper.
  • type: The type of the ID field. Has to be one of the types from search_api_field_types(). List types ("list<*>") are not allowed.

Throws

SearchApiDataSourceException If any error state was encountered.

Overrides SearchApiDataSourceControllerInterface::getIdFieldInfo

File

includes/datasource_multiple.inc, line 21
Contains SearchApiCombinedEntityDataSourceController.

Class

SearchApiCombinedEntityDataSourceController
Provides a datasource for indexing multiple types of entities.

Code

public function getIdFieldInfo() {
  return array(
    'key' => 'item_id',
    'type' => 'string',
  );
}