search_api_elasticsearch_elastica.api.php in Search API Elasticsearch 7

This file contains no working PHP code; it exists to provide additional documentation for Doxygen as well as to document hooks in the standard Drupal manner.

File

modules/elastica/search_api_elasticsearch_elastica.api.php

<?php

/**
 * @file
 * This file contains no working PHP code; it exists to provide additional
 * documentation for Doxygen as well as to document hooks in the standard
 * Drupal manner.
 */

/**
 * Allows modules to alter index configuration during creation.
 *
 * @param array $options
 *   An array of index options.
 */
function hook_search_api_elasticsearch_elastica_add_index_alter(array $options) {
}

/**
 * Allows modules to alter Elastica query.
 *
 * @param \Elastica\Query $elastica_query
 *   The Elastica query object to be altered.
 * @param SearchApiQueryInterface $query
 *   The original Search API query.
 */
function hook_search_api_elasticsearch_elastica_query_alter(\Elastica\Query &$elastica_query, SearchApiQueryInterface $search_api_query) {
}

/**
 * Allows modules to alter documents before sending to Elasticsearch.
 *
 * @param array $documents
 *   An array of documents ready to be indexed, generated from $items array.
 * @param SearchApiIndex $index
 *   The search index for which items are being indexed.
 * @param array $items
 *   An array of items being indexed.
 */
function hook_search_api_elasticsearch_elastica_documents_alter(array &$documents, SearchApiIndex $index, array $items) {
}

Functions

Name	Description
hook_search_api_elasticsearch_elastica_add_index_alter	Allows modules to alter index configuration during creation.
hook_search_api_elasticsearch_elastica_documents_alter	Allows modules to alter documents before sending to Elasticsearch.
hook_search_api_elasticsearch_elastica_query_alter	Allows modules to alter Elastica query.