You are here

interface FacetsQueryTypeMappingInterface in Search API 8

Defines a method for mapping Search API data types to Facets query types.

Hierarchy

Expanded class hierarchy of FacetsQueryTypeMappingInterface

All classes that implement FacetsQueryTypeMappingInterface

File

src/FacetsQueryTypeMappingInterface.php, line 8

Namespace

Drupal\search_api
View source
interface FacetsQueryTypeMappingInterface {

  /**
   * Alters the query types for a specified data type.
   *
   * Backend plugins can use this method to override the default query types
   * provided by the Search API with backend-specific ones that better use
   * features of that backend.
   *
   * @param array $mapping
   *   An associative array mapping data type IDs to arrays of Facets query type
   *   plugin IDs compatible with that data type.
   */
  public function alterFacetQueryTypeMapping(array &$mapping);

}

Members

Namesort descending Modifiers Type Description Overrides
FacetsQueryTypeMappingInterface::alterFacetQueryTypeMapping public function Alters the query types for a specified data type.