handler_argument_more_like_this.inc in Search API 7

Contains SearchApiViewsHandlerArgumentMoreLikeThis.

File

contrib/search_api_views/includes/handler_argument_more_like_this.inc

<?php

/**
 * @file
 * Contains SearchApiViewsHandlerArgumentMoreLikeThis.
 */

/**
 * Views argument handler providing a list of related items for search servers
 * supporting the "search_api_mlt" feature.
 */
class SearchApiViewsHandlerArgumentMoreLikeThis extends SearchApiViewsHandlerArgument {

  /**
   * Specify the options this filter uses.
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['entity_type'] = array(
      'default' => FALSE,
    );
    $options['fields'] = array(
      'default' => array(),
    );
    return $options;
  }

  /**
   * Extend the options form a bit.
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    unset($form['break_phrase']);
    unset($form['not']);
    $index = search_api_index_load(substr($this->table, 17));
    if ($index
      ->datasource() instanceof SearchApiCombinedEntityDataSourceController) {
      $types = array_intersect_key(search_api_entity_type_options_list(), array_flip($index->options['datasource']['types']));
      $form['entity_type'] = array(
        '#type' => 'select',
        '#title' => t('Entity type'),
        '#description' => t('Select the entity type of the argument.'),
        '#options' => $types,
        '#default_value' => $this->options['entity_type'],
        '#required' => TRUE,
      );
    }
    if (!empty($index->options['fields'])) {
      $fields = array();
      foreach ($index
        ->getFields() as $key => $field) {
        $fields[$key] = $field['name'];
      }
    }
    if (!empty($fields)) {
      $form['fields'] = array(
        '#type' => 'select',
        '#title' => t('Fields for Similarity'),
        '#description' => t('Select the fields that will be used for finding similar content. If no fields are selected, all available fields will be used.'),
        '#options' => $fields,
        '#size' => min(8, count($fields)),
        '#multiple' => TRUE,
        '#default_value' => $this->options['fields'],
      );
    }
    else {
      $form['fields'] = array(
        '#type' => 'value',
        '#value' => array(),
      );
    }
  }

  /**
   * Set up the query for this argument.
   *
   * The argument sent may be found at $this->argument.
   */
  public function query($group_by = FALSE) {
    try {
      $server = $this->query
        ->getIndex()
        ->server();
      if (!$server
        ->supportsFeature('search_api_mlt')) {
        $class = search_api_get_service_info($server->class);
        watchdog('search_api_views', 'The search service "@class" does not offer "More like this" functionality.', array(
          '@class' => $class['name'],
        ), WATCHDOG_ERROR);
        $this->query
          ->abort();
        return;
      }
      $index_fields = array_keys($this->query
        ->getIndex()->options['fields']);
      if (empty($this->options['fields'])) {
        $fields = $index_fields;
      }
      else {
        $fields = array_intersect($this->options['fields'], $index_fields);
      }
      if ($this->query
        ->getIndex()
        ->datasource() instanceof SearchApiCombinedEntityDataSourceController) {
        $id = $this->options['entity_type'] . '/' . $this->argument;
      }
      else {
        $id = $this->argument;
      }
      $mlt = array(
        'id' => $id,
        'fields' => $fields,
      );
      $this->query
        ->getSearchApiQuery()
        ->setOption('search_api_mlt', $mlt);
    } catch (SearchApiException $e) {
      $this->query
        ->abort($e
        ->getMessage());
    }
  }

}

Classes

Name	Description
SearchApiViewsHandlerArgumentMoreLikeThis	Views argument handler providing a list of related items for search servers supporting the "search_api_mlt" feature.