elasticsearch_connector_search_api.api.php in Elasticsearch Connector 7

Hooks provided by the Elasticsearch Connector Search API module.

File

modules/elasticsearch_connector_search_api/elasticsearch_connector_search_api.api.php

<?php

/**
 * @file
 * Hooks provided by the Elasticsearch Connector Search API module.
 */

/**
 * Lets modules alter an Elastic search request before sending it.
 *
 * @param SearchApiQueryInterface $query
 *   The SearchApiQueryInterface object representing the executed search query.
 * @param array $params
 *   An associative array containing the index being queried, the type,
 *   the fields, the query_string etc.
 */
function hook_elasticsearch_connector_search_api_query_alter($query, &$params) {
}

/**
 * Lets modules alter the search results returned from an Elastic search.
 *
 * @param array $results
 *   The results array that will be returned for the search.
 * @param SearchApiQueryInterface $query
 *   The SearchApiQueryInterface object representing the executed search query.
 * @param array $response
 *   The Elastic Search response array.
 */
function hook_elasticsearch_connector_search_api_results_alter(&$results, $query, $response) {
}

/**
 * Lets modules alter the forced index creation from SearchApi integration.
 *
 * @param SearchApiIndex $index
 * @param array $params
 */
function hook_elasticsearch_connector_search_api_add_index($index, &$params) {
}

/**
 * Lets modules alter the items (documents) that will be send to
 * Elasticsearch server for indexing.
 *
 * @param object $index
 *   The Search API index object.
 * @param array $params
 *   The params that are going to be send to the Elasticsearch server.
 * @param array $items
 *   The original items used to build the params variable.
 */
function hook_elasticsearch_connector_search_api_index_items($index, &$params, $items) {
}

/**
 * Lets modules alter the full mapping that will be created.
 *
 * @param object $index
 *   The Search API index object.
 * @param array $type_mapping
 *   The full mapping under the type section, includes the properties section.
 */
function hook_elasticsearch_connector_search_api_mapping_update_alter($index, &$type_mapping) {
}

Functions

Name	Description
hook_elasticsearch_connector_search_api_add_index	Lets modules alter the forced index creation from SearchApi integration.
hook_elasticsearch_connector_search_api_index_items	Lets modules alter the items (documents) that will be send to Elasticsearch server for indexing.
hook_elasticsearch_connector_search_api_mapping_update_alter	Lets modules alter the full mapping that will be created.
hook_elasticsearch_connector_search_api_query_alter	Lets modules alter an Elastic search request before sending it.
hook_elasticsearch_connector_search_api_results_alter	Lets modules alter the search results returned from an Elastic search.