class SearchApiElasticsearchQuery in Search API Elasticsearch 7.2

@file

Hierarchy

class \SearchApiElasticsearchQuery

Expanded class hierarchy of SearchApiElasticsearchQuery

File

includes/SearchApiElasticsearchQuery.inc, line 17

View source

class SearchApiElasticsearchQuery {

  /**
   * @var SearchApiQueryInterface
   */
  protected $search_api_query;

  /**
   * @var SearchApiElasticsearchService
   */
  protected $search_api_service;

  /**
   * @var Query
   */
  protected $query;

  /**
   * @var array
   */
  protected $query_options;

  /**
   * SearchApiElasticsearchQuery constructor.
   * @param SearchApiQueryInterface $query
   * @param SearchApiElasticsearchService $service
   */
  public function __construct(SearchApiQueryInterface $query, SearchApiElasticsearchService $service) {
    $this->search_api_query = $query;
    $this->search_api_service = $service;
    $this->index_fields = $query
      ->getIndex()
      ->getFields();
    $this->query_options = $query
      ->getOptions();
  }

  /**
   * Build Elastica query for Elasticsearch.
   *
   * @throws Exception
   */
  protected function build() {
    $this->query = new Query();
    $offset = empty($this->query_options['offset']) ? 0 : $this->query_options['offset'];
    $limit = empty($this->query_options['limit']) ? 10 : $this->query_options['limit'];
    $keys = $this->search_api_query
      ->getKeys();
    if (!empty($keys)) {
      if (is_string($keys)) {
        $keys = array(
          $keys,
        );
      }
      $full_text_fields = $this->search_api_query
        ->getFields();
      $string = $this
        ->flattenKeys($keys, $this->query_options['parse mode']);
      if (!empty($string)) {
        $query_string = new QueryString($string);
        $query_string
          ->setFields(array_values($full_text_fields));
      }
    }
    $sort = $this
      ->getSortQuery();
    $parsed_filters = $this
      ->parseFilter($this->search_api_query
      ->getFilter());
    if (!empty($parsed_filters)) {
      $search_filter = $parsed_filters[0];
    }
    $this->query
      ->setFrom($offset);
    $this->query
      ->setSize($limit);
    if (isset($query_string) && isset($search_filter)) {
      $bool_query = new BoolQuery();
      $bool_query
        ->addMust($query_string);
      $bool_query
        ->addFilter($search_filter);
      $this->query
        ->setQuery($bool_query);
    }
    elseif (isset($query_string)) {
      $this->query
        ->setQuery($query_string);
    }
    elseif (isset($search_filter)) {
      $this->query
        ->setPostFilter($search_filter);
    }
    if (!empty($sort)) {
      $this->query
        ->setSort($sort);
    }
    $this
      ->addAggregations();
  }

  /**
   * Execute a search.
   *
   * @return array
   */
  public function search() {
    $this
      ->build();
    $index = new SearchApiElasticsearchIndex($this->search_api_query
      ->getIndex(), $this->search_api_service);
    $elasticsearch_index = $index
      ->getElasticsearchIndex();
    $result_set = $elasticsearch_index
      ->search($this->query);
    return $this
      ->parseResults($result_set);
  }

  /**
   * Parse Elasticsearch results for use by Search API.
   *
   * @param ResultSet $result_set
   * @return array
   */
  protected function parseResults(ResultSet $result_set) {
    $search_result = [
      'results' => [],
    ];
    $search_result['result count'] = $result_set
      ->getTotalHits();
    foreach ($result_set
      ->getResults() as $result) {
      $id = $result
        ->getId();
      $search_result['results'][$id] = [
        'id' => $id,
        'score' => $result
          ->getScore(),
        'fields' => $result
          ->getSource(),
      ];
    }
    $search_result['search_api_facets'] = $this
      ->parseAggregations($result_set);
    return $search_result;
  }

  /**
   * Parse aggregations for Facet API.
   *
   * @param ResultSet $result_set
   * @return array
   */
  protected function parseAggregations(ResultSet $result_set) {
    $result = [];
    $aggregations = $this->search_api_query
      ->getOption('search_api_facets');
    if (!empty($aggregations) && $result_set
      ->hasAggregations()) {
      foreach ($result_set
        ->getAggregations() as $aggregation_id => $aggregation_data) {
        if (isset($aggregations[$aggregation_id])) {
          $aggregation_info = $aggregations[$aggregation_id];
          $aggregation_min_count = $aggregation_info['min_count'];
          $field_id = $aggregation_info['field'];
          $field_type = search_api_extract_inner_type($this->index_fields[$field_id]['type']);
          if ($field_type === 'date') {
            foreach ($aggregation_data['buckets'] as $entry) {
              if ($entry['doc_count'] >= $aggregation_min_count) {
                $result[$aggregation_id][] = [
                  'count' => $entry['doc_count'],
                  'filter' => '"' . $entry['key'] / 1000 . '"',
                ];
              }
            }
          }
          else {
            foreach ($aggregation_data['buckets'] as $term) {
              if ($term['doc_count'] >= $aggregation_min_count) {
                $result[$aggregation_id][] = array(
                  'count' => $term['doc_count'],
                  'filter' => '"' . $term['key'] . '"',
                );
              }
            }
          }
        }
      }
    }
    return $result;
  }

  /**
   * Add aggregations to an Elasticsearch query.
   */
  protected function addAggregations() {
    $aggregations = $this->search_api_query
      ->getOption('search_api_facets');
    if (!empty($aggregations)) {
      $searcher = key(facetapi_get_active_searchers());

      /** @var SearchApiFacetapiAdapter $adapter */
      $adapter = isset($searcher) ? facetapi_adapter_load($searcher) : NULL;
      $enabled_facets = $adapter
        ->getEnabledFacets();
      foreach ($aggregations as $aggregation_id => $aggregation_info) {
        $aggregation = null;
        $field_id = $aggregation_info['field'];
        if (!isset($this->index_fields[$field_id])) {
          continue;
        }
        $field_type = search_api_extract_inner_type($this->index_fields[$field_id]['type']);

        /** @var FacetapiFacet $facet */
        $facet = $adapter
          ->getFacet($enabled_facets[$aggregation_id]);
        $facet_settings = $facet
          ->getSettings();
        if ($field_type === 'date') {
          $gap_weight = array(
            'YEAR' => 2,
            'MONTH' => 1,
            'DAY' => 0,
          );

          // Get the date granularity.
          $date_gap = $facet_settings->settings['date_granularity'];

          // Get the current date gap from the active date filters.
          $active_items = $adapter
            ->getActiveItems(array(
            'name' => $aggregation_id,
          ));
          if (!empty($active_items)) {
            foreach ($active_items as $active_item) {
              $value = $active_item['value'];
              if (strpos($value, ' TO ') > 0) {
                list($date_min, $date_max) = explode(' TO ', str_replace(array(
                  '[',
                  ']',
                ), '', $value), 2);
                $gap = facetapi_get_timestamp_gap($date_min, $date_max);
                if (isset($gap_weight[$gap])) {
                  $gaps[] = $gap_weight[$gap];
                }
              }
            }
            if (!empty($gaps)) {

              // Minimum gap.
              $date_gap = array_search(min($gaps), $gap_weight);
            }
          }
          switch ($date_gap) {

            // Already a selected YEAR, we want the months.
            case 'YEAR':
              $date_interval = 'month';
              break;

            // Already a selected MONTH, we want the days.
            case 'MONTH':
              $date_interval = 'day';
              break;

            // Already a selected DAY, we want the hours and so on.
            case 'DAY':
              $date_interval = 'hour';
              break;

            // By default we return result counts by year.
            default:
              $date_interval = 'year';
          }
          $aggregation = new \Elastica\Aggregation\DateHistogram($aggregation_id, $field_id, $date_interval);
        }
        elseif ($field_type === 'string') {
          if (strpos($aggregation_id, 'latlon') !== false) {
          }
          else {
            $aggregation = new Terms($aggregation_id);
          }
        }
        if (!empty($aggregation)) {
          $this
            ->setAggregationOptions($aggregation, $field_type, $aggregation_info);
          $this->query
            ->addAggregation($aggregation);
        }
      }
    }
  }

  /**
   * Configure an aggregation.
   * @param AbstractSimpleAggregation $aggregation
   * @param $field_type
   * @param $aggregation_info
   */
  protected function setAggregationOptions(AbstractSimpleAggregation $aggregation, $field_type, $aggregation_info) {
    $aggregation_limit = $this
      ->getAggregationLimit($aggregation_info);
    $aggregation_filter = $this
      ->getAggregationFilter($aggregation_info, $field_type);
    if (!empty($aggregation_filter)) {
      $filter = new Filter($aggregation_info['field']);
      $filter
        ->setFilter($aggregation_filter);
      $aggregation
        ->addAggregation($filter);
    }
    if ($aggregation_limit > 0 && method_exists($aggregation, 'setSize')) {
      $aggregation
        ->setSize($aggregation_limit);
    }
    $aggregation
      ->setField($aggregation_info['field']);
  }

  /**
   * Helper method to get limits for aggregations.
   * @param $aggregation_info
   * @return int
   */
  protected function getAggregationLimit($aggregation_info) {
    $aggregation_limit = !empty($aggregation_info['limit']) ? $aggregation_info['limit'] : -1;
    if ($aggregation_limit > 0) {
      $aggregation_limit = $this->search_api_query
        ->getOption('facet_limit', 10);
    }
    return $aggregation_limit;
  }

  /**
   * Helper method to get filters for aggregations.
   *
   * @param array $aggregation_info
   * @param string $field_type
   * @return AbstractQuery
   */
  protected function getAggregationFilter($aggregation_info, $field_type) {
    if (isset($aggregation_info['operator']) && drupal_strtolower($aggregation_info['operator']) === 'or') {
      $aggregation_filter = $this
        ->parseFilter($this->search_api_query
        ->getFilter(), $field_type, $aggregation_info['field']);
      if (!empty($aggregation_filter)) {
        $aggregation_filter = $aggregation_filter[0];
      }
    }
    else {
      $aggregation_filter = $this
        ->parseFilter($this->search_api_query
        ->getFilter(), $field_type);
      if (!empty($aggregation_filter)) {
        $aggregation_filter = $aggregation_filter[0];
      }
    }
    return $aggregation_filter;
  }

  /**
   * Parse Search API filters.
   *
   * @param SearchApiQueryFilterInterface $query_filter
   * @param string $field_type
   * @param string $ignored_field
   * @return array|null
   * @throws Exception
   */
  protected function parseFilter(SearchApiQueryFilterInterface $query_filter, $field_type = null, $ignored_field = null) {
    if (empty($query_filter) || empty($field_type)) {
      return null;
    }
    else {
      $conjunction = $query_filter
        ->getConjunction();
      $filters = [];
      foreach ($query_filter
        ->getFilters() as $filter_info) {
        $filter = null;

        // Simple filter [field_id, value, operator]
        if (is_array($filter_info)) {
          $filter_operator = str_replace('!=', '<>', $filter_info[2]);
          $filter_array = [
            'field_id' => $filter_info[0],
            'field_value' => $filter_info[1],
            'filter_operator' => $filter_operator,
          ];
          $this
            ->verifyFilterConfiguration($filter_array, $ignored_field);

          // Handle parse date filters.
          if ($field_type == 'date') {
            $filter_array['field_value'] = date(SEARCH_API_ELASTICSEARCH_DATE_FORMAT, $filter_array['field_value']);
          }
          $filter = $this
            ->getFilter($filter_array);
          if (!empty($filter)) {
            $filters[] = $filter;
          }
        }
        elseif ($filter_info instanceof SearchApiQueryFilterInterface) {
          $nested_filters = $this
            ->parseFilter($filter_info, $field_type);
          if (!empty($nested_filters)) {
            $filters = array_merge($filters, $nested_filters);
          }
        }
      }
      $this
        ->joinFilters($filters, $conjunction);
      return $filters;
    }
  }

  /**
   * Verify that a filter has the necessary array keys.
   *
   * @param $filter_array
   * @param $ignored_field
   * @return bool
   * @throws Exception
   */
  protected function verifyFilterConfiguration($filter_array, $ignored_field) {
    if (!array_key_exists('field_id', $filter_array) || !array_key_exists('field_value', $filter_array) || !isset($filter_array['filter_operator'])) {
      throw new Exception(t('Incorrect filter criteria is using for searching!'));
    }
    $field_id = $filter_array['field_id'];

    // If field should be ignored, we skip.
    if ($field_id === $ignored_field) {
      return TRUE;
    }
    if (!isset($this->index_fields[$field_id])) {
      throw new Exception(t(':field_id Undefined field ! Incorrect filter criteria is using for searching!', array(
        ':field_id' => $field_id,
      )));
    }

    // Check operator.
    if (empty($filter_array['filter_operator'])) {
      throw new Exception(t('Empty filter operator for :field_id field! Incorrect filter criteria is using for searching!', array(
        ':field_id' => $field_id,
      )));
    }
    return TRUE;
  }

  /**
   * Get Elasticsearch aggregation queries for Search API filters.
   *
   * @param $filter_array
   * @return AbstractQuery || null
   */
  protected function getFilter($filter_array) {

    // Handle "empty", "not empty" operators.
    if (!isset($filter_array['field_value'])) {
      switch ($filter_array['filter_operator']) {
        case '<>':
          return new Exists($filter_array['field_id']);
        case '=':
          $query = new BoolQuery();
          $query
            ->addMustNot(new Exists($filter_array['field_id']));
          return $query;
      }
    }
    else {
      switch ($filter_array['field_value']) {
        case '>':
          $query = new RangeQuery($filter_array['field_id'], [
            'gt' => $filter_array['field_value'],
          ]);
          break;
        case '>=':
          $query = new RangeQuery($filter_array['field_id'], [
            'gte' => $filter_array['field_value'],
          ]);
          break;
        case '<':
          $query = new RangeQuery($filter_array['field_id'], [
            'lt' => $filter_array['field_value'],
          ]);
          break;
        case '<=':
          $query = new RangeQuery($filter_array['field_id'], [
            'lte' => $filter_array['field_value'],
          ]);
          break;
        default:
          $query = new Query\Term();
          $query
            ->setTerm($filter_array['field_id'], $filter_array['field_value']);
      }
      return $query;
    }
    return null;
  }

  /**
   * Join Elasticsearch aggregation queries.
   *
   * @param $filters
   * @param $conjunction
   * @throws Exception
   */
  protected function joinFilters(&$filters, $conjunction) {
    if (count($filters) > 1) {
      if ($conjunction === 'OR') {
        $query = new BoolQuery();
        $query
          ->addShould($filters);
        $filters = array(
          $query,
        );
      }
      elseif ($conjunction === 'AND') {
        $query = new BoolQuery();
        $query
          ->addMust($filters);
        $filters = array(
          $query,
        );
      }
      else {
        throw new Exception(t('Undefined conjunction :conjunction! Available values are "AND" and "OR"! Incorrect filter criteria is using for searching!', array(
          ':conjunction!' => $conjunction,
        )));
      }
    }
  }

  /**
   * Flatten keys for full text search.
   *
   * @param $keys
   * @param string $parse_mode
   * @param array $full_text_fields
   * @return string
   */
  protected function flattenKeys($keys, $parse_mode = '', $full_text_fields = array()) {
    $conjunction = isset($keys['#conjunction']) ? $keys['#conjunction'] : 'AND';
    $negation = !empty($keys['#negation']);
    $values = array();
    foreach (element_children($keys) as $key) {
      $value = $keys[$key];
      if (empty($value)) {
        continue;
      }
      if (is_array($value)) {
        $values[] = $this
          ->flattenKeys($value);
      }
      elseif (is_string($value)) {

        // If parse mode is not "direct": quote the keyword.
        if ($parse_mode !== 'direct') {
          $value = '"' . $value . '"';
        }
        $values[] = $value;
      }
    }
    if (!empty($values)) {
      return ($negation === TRUE ? 'NOT ' : '') . '(' . implode(" {$conjunction} ", $values) . ')';
    }
    else {
      return '';
    }
  }

  /**
   * Get sorting configuration.
   *
   * @return array
   * @throws Exception
   */
  protected function getSortQuery() {
    $sort = [];
    foreach ($this->search_api_query
      ->getSort() as $field_id => $direction) {
      $direction = drupal_strtolower($direction);
      if ($field_id === 'search_api_relevance') {
        $sort['_score'] = $direction;
      }
      elseif (isset($this->index_fields[$field_id])) {
        $sort[$field_id] = $direction;
      }
      else {
        throw new Exception(t('Incorrect Sorting!'));
      }
    }
    return $sort;
  }

}

Members

Name	Modifiers	Type	Description
SearchApiElasticsearchQuery::$query	protected	property
SearchApiElasticsearchQuery::$query_options	protected	property
SearchApiElasticsearchQuery::$search_api_query	protected	property
SearchApiElasticsearchQuery::$search_api_service	protected	property
SearchApiElasticsearchQuery::addAggregations	protected	function	Add aggregations to an Elasticsearch query.
SearchApiElasticsearchQuery::build	protected	function	Build Elastica query for Elasticsearch.
SearchApiElasticsearchQuery::flattenKeys	protected	function	Flatten keys for full text search.
SearchApiElasticsearchQuery::getAggregationFilter	protected	function	Helper method to get filters for aggregations.
SearchApiElasticsearchQuery::getAggregationLimit	protected	function	Helper method to get limits for aggregations.
SearchApiElasticsearchQuery::getFilter	protected	function	Get Elasticsearch aggregation queries for Search API filters.
SearchApiElasticsearchQuery::getSortQuery	protected	function	Get sorting configuration.
SearchApiElasticsearchQuery::joinFilters	protected	function	Join Elasticsearch aggregation queries.
SearchApiElasticsearchQuery::parseAggregations	protected	function	Parse aggregations for Facet API.
SearchApiElasticsearchQuery::parseFilter	protected	function	Parse Search API filters.
SearchApiElasticsearchQuery::parseResults	protected	function	Parse Elasticsearch results for use by Search API.
SearchApiElasticsearchQuery::search	public	function	Execute a search.
SearchApiElasticsearchQuery::setAggregationOptions	protected	function	Configure an aggregation.
SearchApiElasticsearchQuery::verifyFilterConfiguration	protected	function	Verify that a filter has the necessary array keys.
SearchApiElasticsearchQuery::__construct	public	function	SearchApiElasticsearchQuery constructor.

You are here

class SearchApiElasticsearchQuery in Search API Elasticsearch 7.2

Hierarchy

File

Members

API Navigation