You are here

Home » API reference » Apache Solr Views 7 » apachesolr_views_query.inc

class apachesolr_views_query in Apache Solr Views 7

Same name and namespace in other branches
  1. 6 apachesolr_views_query.inc \apachesolr_views_query

@file Views query plugin for Apache Solr Views. Gets its data not from the database, but from a Solr server.

Hierarchy

Expanded class hierarchy of apachesolr_views_query

4 string references to 'apachesolr_views_query'
apachesolr_views_query::execute in ./apachesolr_views_query.inc
Executes the query.
apachesolr_views_views_data in ./apachesolr_views.views.inc
Implements of hook_views_data().
apachesolr_views_views_plugins in ./apachesolr_views.views.inc
Implements of hook_views_plugins().
apachesolr_views_views_query_alter in ./apachesolr_views.module
Implements hook_views_query_alter().

File

./apachesolr_views_query.inc, line 9
Views query plugin for Apache Solr Views. Gets its data not from the database, but from a Solr server.

View source 
class apachesolr_views_query extends views_plugin_query {

  /**
   * Array of parameters for Solr query.
   */
  protected $params;
  protected $query_params;
  public $orderby = array();

  /**
   * Store results of apachesolr search.
   */
  protected $apachesolr_results;

  /**
   * Array of where conditions.
   *
   * Neede for grouppin of query conditions.
   */
  protected $where = array();

  /**
   * The default group operator.
   *
   * @var string
   */
  protected $group_operator = 'AND';

  /**
   * Builds what is necessary prior to executing the query.
   */
  public function build(&$view) {
    $view
      ->init_pager();

    // Let the pager modify the query to add limits.
    $this->pager
      ->query();

    // Add fields to the query so they will be shown in solr document.
    $this->params['fl'] = array_keys($view->field);
    $params = array();
    if (isset($this->params['q'])) {
      $params['q'] = $this->params['q'];
    }
    $params['rows'] = $this->pager->options['items_per_page'];
    $params['start'] = $this->pager->current_page * $this->pager->options['items_per_page'];

    // If we display all items without pager.
    if ($params['rows'] == 0) {
      $params['rows'] = 100000;
    }

    // Add fields.
    $params['fl'] = array(
      'id',
      'entity_id',
    );
    if (isset($this->params['fl'])) {
      $params['fl'] = array_merge($params['fl'], $this->params['fl']);
    }
    $params['fl'] = implode(',', $params['fl']);
    if (isset($this->params['hl'])) {
      $params['hl'] = $this->params['hl'];
    }
    if (isset($this->params['hl'])) {
      $params['f.content.hl.alternateField'] = $this->params['f.content.hl.alternateField'];
    }
    if (isset($this->params['hl.snippets'])) {
      $params['hl.snippets'] = $this->params['hl.snippets'];
    }
    $where = $this->where;

    // Remove any empty conditions (exposed filters), they will cause an error.
    foreach ($where as &$where_condition) {
      foreach ($where_condition['conditions'] as $index => $condition) {
        if ($condition['value'] == '') {
          unset($where_condition['conditions'][$index]);
        }
      }
    }

    // Add conditions to filter parameter.
    $conditions = array(
      'conditions' => $where,
      'type' => $this->group_operator,
    );
    $conditions_string = $this
      ->build_where_string($conditions);
    if (!empty($conditions_string)) {
      $params['fq'] = $conditions_string;
    }

    // Set query type if it is present.
    if (isset($this->params['defType'])) {
      $params['defType'] = $this->params['defType'];
    }
    $this->query_params = $params;

    // Export parameters for preview.
    $view->build_info['query'] = var_export($params, TRUE);
  }

  /**
   * Let modules modify the query just prior to finalizing it.
   */
  public function alter(&$view) {
    foreach (module_implements('views_query_alter') as $module) {
      $function = $module . '_views_query_alter';
      $function($view, $this);
    }
  }

  /**
   * Executes the query.
   *
   * Assigns the resulting values to the view object.
   * Values to set: $view->result, $view->total_rows, $view->execute_time.
   */
  public function execute(&$view) {
    try {
      $start = microtime(TRUE);

      // Execute the search.
      // Load search query.
      // Get the Apache Solr "environment id".
      if (strpos($view->base_table, 'apachesolr__') === 0) {
        $env_id = substr($view->base_table, 12);
      }
      else {
        $env_id = apachesolr_default_environment();
      }
      $solr = apachesolr_get_solr($env_id);
      $context = array(
        'search_type' => 'apachesolr_views_query',
        'view_name' => $view->name,
        'current_display' => $view->current_display,
      );
      $query = new ApachesolrViewsSolrBaseQuery('apachesolr', $solr, $this->query_params, '', current_path(), $context, $view);

      // Add sorting. The setSolrsort method can't be used, because it doesn't support multiple sorting criteria.
      $query
        ->replaceParam('sort', $this->orderby);
      $query->page = $this->pager->current_page;

      // Boost parameters if apachesolr_search module is available.
      apachesolr_search_add_boost_params($query);

      // Execute search.
      list($final_query, $response) = apachesolr_do_query($query);
      apachesolr_has_searched($solr
        ->getId(), TRUE);
      if ($response) {

        // Store results.
        $view->result = $response->response->docs;

        // Store apachesolr cached response.
        $this->apachesolr_response = $response;

        // Store the results.
        $this->pager->total_items = $view->total_rows = $this->apachesolr_response->response->numFound;
        $this->pager
          ->update_page_info();
      }
    } catch (Exception $e) {
      $view->result = array();
      $view->total_rows = 0;
      if (!empty($view->live_preview)) {
        drupal_set_message($e
          ->getMessage(), 'error');
      }
      else {
        vpr('Exception in @human_name[@view_name]: @message', array(
          '@human_name' => $view->human_name,
          '@view_name' => $view->name,
          '@message' => $e
            ->getMessage(),
        ));
      }
    }
    $view->execute_time = microtime(TRUE) - $start;
  }
  public function add_filter($type, $value, $exclude = FALSE) {
    $exclude_string = $exclude ? '-' : '';
    $this->params['filters'][] = $exclude_string . $type . ':(' . $value . ')';
  }
  public function add_filter_string($string) {
    $this->params['q.alt'][] = $string;
  }
  public function add_sort($field, $order) {
    $this->orderby[] = "{$field} {$order}";
  }
  public function add_parameter($key, $value) {
    $this->params[$key] = $value;
  }
  public function add_field($table_alias, $field, $alias = '', $params = array()) {

    // Make sure an alias is assigned.
    $alias = $alias ? $alias : $field;
    return $alias;
  }
  public function get_params() {
    return $this->params;
  }

  /**
   *  Build filter string from where array.
   */
  function build_where_string($where) {
    if (!isset($where['conditions'])) {
      return $where['field'] . ':(' . $where['value'] . ')';
    }
    else {
      $condition_strings = array();
      foreach ($where['conditions'] as $condition) {
        $condition_strings[] = $this
          ->build_where_string($condition);
      }
      $condition_strings = array_filter($condition_strings);
      $condition_string = implode(' ' . $where['type'] . ' ', $condition_strings);

      // Respect grouping by wrapping multiple conditions with parenthesis.
      if (count($condition_strings) > 1) {
        $condition_string = '(' . $condition_string . ')';
      }
      return $condition_string;
    }
  }

  /**
   * Support for groupping.
   *
   * @see views_plugin_query_default::add_where().
   */
  function add_where($group, $field, $value = NULL, $operator = NULL) {

    // Ensure all variants of 0 are actually 0. Thus '', 0 and NULL are all
    // the default group.
    if (empty($group)) {
      $group = 0;
    }

    // Check for a group.
    if (!isset($this->where[$group])) {
      $this
        ->set_where_group('AND', $group);
    }
    $this->where[$group]['conditions'][] = array(
      'field' => $field,
      'value' => $value,
      'operator' => $operator,
    );
  }

  /**
   * Support for groupping.
   *
   * @see views_plugin_query_default::set_where_group().
   */
  function set_where_group($type = 'AND', $group = NULL, $where = 'where') {

    // Set an alias.
    $groups =& $this->{$where};
    if (!isset($group)) {
      $group = empty($groups) ? 1 : max(array_keys($groups)) + 1;
    }

    // Create an empty group
    if (empty($groups[$group])) {
      $groups[$group] = array(
        'conditions' => array(),
        'args' => array(),
      );
    }
    $groups[$group]['type'] = strtoupper($type);
    return $group;
  }

  /**
   * Implement ensure_table, do nothing.
   */
  function ensure_table($table, $relationship = NULL, $join = NULL) {
  }

}

Members

Namesort descending Modifiers Type Description Overrides
apachesolr_views_query::$apachesolr_results protected property Store results of apachesolr search.
apachesolr_views_query::$group_operator protected property The default group operator.
apachesolr_views_query::$orderby public property
apachesolr_views_query::$params protected property Array of parameters for Solr query.
apachesolr_views_query::$query_params protected property
apachesolr_views_query::$where protected property Array of where conditions.
apachesolr_views_query::add_field public function
apachesolr_views_query::add_filter public function
apachesolr_views_query::add_filter_string public function
apachesolr_views_query::add_parameter public function
apachesolr_views_query::add_sort public function
apachesolr_views_query::add_where function Support for groupping.
apachesolr_views_query::alter public function Let modules modify the query just prior to finalizing it. Overrides views_plugin_query::alter
apachesolr_views_query::build public function Builds what is necessary prior to executing the query. Overrides views_plugin_query::build
apachesolr_views_query::build_where_string function Build filter string from where array.
apachesolr_views_query::ensure_table function Implement ensure_table, do nothing.
apachesolr_views_query::execute public function Executes the query. Overrides views_plugin_query::execute
apachesolr_views_query::get_params public function
apachesolr_views_query::set_where_group function Support for groupping. Overrides views_plugin_query::set_where_group
views_object::$definition public property Handler's definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition function Collect this handler's option definition and alter them, ready for use.
views_object::construct public function Views handlers use a special construct function. 4
views_object::destroy public function Destructor. 2
views_object::export_option public function 1
views_object::export_options public function
views_object::export_option_always public function Always exports the option, regardless of the default value.
views_object::options Deprecated public function Set default options on this object. 1
views_object::option_definition public function Information about options for all kinds of purposes will be held here. 13
views_object::set_default_options public function Set default options.
views_object::set_definition public function Let the handler know what its full definition is.
views_object::unpack_options public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable public function Unpack a single option definition.
views_object::unpack_translatables public function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults public function
views_plugin::$display public property The current used views display.
views_plugin::$plugin_name public property The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type public property The plugin type of this plugin, for example style or query.
views_plugin::$view public property The top object of a view. Overrides views_object::$view 1
views_plugin::additional_theme_functions public function Provide a list of additional theme functions for the theme info page.
views_plugin::plugin_title public function Return the human readable name of the display.
views_plugin::theme_functions public function Provide a full list of possible theme templates used by this style.
views_plugin::validate public function Validate that the plugin is correct and can be saved. 3
views_plugin_query::$pager public property A pager plugin that should be provided by the display. 1
views_plugin_query::add_signature public function Add a signature to the query, if such a thing is feasible. 1
views_plugin_query::get_aggregation_info public function Get aggregation info for group by queries. 1
views_plugin_query::get_result_entities public function Returns the according entity objects for the given query results. 1
views_plugin_query::init public function Constructor; Create the basic query object and fill with default values. 1
views_plugin_query::options_form public function Add settings for the ui. Overrides views_plugin::options_form 1
views_plugin_query::options_submit public function Handle any special handling on the validate form. Overrides views_plugin::options_submit 1
views_plugin_query::options_validate public function Validate the options form. Overrides views_plugin::options_validate
views_plugin_query::query public function Generate a query and a countquery from all of the information supplied to the object. Overrides views_plugin::query 1
views_plugin_query::render_pager public function Render the pager, if necessary.
views_plugin_query::set_group_operator public function Control how all WHERE and HAVING groups are put together.
views_plugin_query::set_limit public function Set a LIMIT on the query, specifying a maximum number of results.
views_plugin_query::set_offset public function Set an OFFSET on the query, specifying a number of results to skip
views_plugin_query::summary_title public function Returns the summary of the settings in the display. Overrides views_plugin::summary_title