public function SearchApiDataSourceControllerInterface::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.

1 call to SearchApiDataSourceControllerInterface::getIdFieldInfo()

SearchApiAbstractDataSourceController::getItemId in includes/datasource.inc

Retrieves the unique ID of an item.

3 methods override SearchApiDataSourceControllerInterface::getIdFieldInfo()

SearchApiCombinedEntityDataSourceController::getIdFieldInfo in includes/datasource_multiple.inc

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

SearchApiEntityDataSourceController::getIdFieldInfo in includes/datasource_entity.inc

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

SearchApiExternalDataSourceController::getIdFieldInfo in includes/datasource_external.inc

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

File

includes/datasource.inc, line 44

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 getIdFieldInfo();