public function MappingForeignRelationshipsEvent::getForeignRelationshipsMapping in Search API 8

Retrieves a reference to the foreign relationships mapping.

Return value

array[] A (numerically keyed) array of foreign relationship mappings. Each sub-array here represents a single known relationship. Such sub-arrays will have the following structure:

• datasource: (string) The ID of the datasource which contains this relationship.
• entity_type: (string) Entity type that is referred to from the index.
• bundles: (array) Optional array of particular entity bundles that are referred to from the index. Empty array here means index refers to all the bundles.
• property_path_to_foreign_entity: (string) Property path where the index refers to this entity.
• field_name: (string) Name of the field on the referenced entity that actively participates in the search index.

File

src/Event/MappingForeignRelationshipsEvent.php, line 81

Class

MappingForeignRelationshipsEvent

Wraps a foreign relationships mapping event.

Namespace

Drupal\search_api\Event

Code

public function &getForeignRelationshipsMapping() : array {
  return $this->foreignRelationshipsMapping;
}