You are here

public function IndexInterface::getPropertyDefinitions in Search API 8

Retrieves the properties of one of this index's datasources.

Parameters

string|null $datasource_id: The ID of the datasource for which the properties should be retrieved. Or NULL to retrieve all datasource-independent properties.

Return value

\Drupal\Core\TypedData\DataDefinitionInterface[] The properties belonging to the given datasource that are available in this index, keyed by their property names (not the complete field IDs).

Throws

\Drupal\search_api\SearchApiException Thrown if the specified datasource isn't enabled for this index, or couldn't be loaded.

2 methods override IndexInterface::getPropertyDefinitions()
Index::getPropertyDefinitions in src/Entity/Index.php
Retrieves the properties of one of this index's datasources.
UnsavedIndexConfiguration::getPropertyDefinitions in src/UnsavedIndexConfiguration.php
Retrieves the properties of one of this index's datasources.

File

src/IndexInterface.php, line 552

Class

IndexInterface
Defines the interface for index entities.

Namespace

Drupal\search_api

Code

public function getPropertyDefinitions($datasource_id);