You are here

public function SearchApiExternalDataSourceController::getIdFieldInfo in Search API 7

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

This implementation will return a field named "id" of type "string". This can also be used if the item type in question has no IDs.

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.

Overrides SearchApiDataSourceControllerInterface::getIdFieldInfo

File

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

Class

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

Code

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