You are here

Home » API reference » Views (for Drupal 7) 7.3 » views_handler_filter_search.inc

class views_handler_filter_search in Views (for Drupal 7) 7.3

Same name and namespace in other branches
  1. 6.3 modules/search/views_handler_filter_search.inc \views_handler_filter_search
  2. 6.2 modules/search/views_handler_filter_search.inc \views_handler_filter_search

Field handler to provide simple renderer that allows linking to a node.

Hierarchy

Expanded class hierarchy of views_handler_filter_search

Related topics

Views filter handlers
Handlers to tell Views how to filter queries.
1 string reference to 'views_handler_filter_search'
search_views_data in modules/search.views.inc
Implements hook_views_data().

File

modules/search/views_handler_filter_search.inc, line 13
Definition of views_handler_filter_search.

View source 
class views_handler_filter_search extends views_handler_filter {

  /**
   *
   */
  public $always_multiple = TRUE;

  /**
   * Stores a viewsSearchQuery object to be able to use the search.module "api".
   *
   * @var viewsSearchQuery
   */
  public $search_query = NULL;

  /**
   * Checks if the search query has been parsed.
   */
  public $parsed = FALSE;

  /**
   * {@inheritdoc}
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['operator']['default'] = 'optional';
    $options['remove_score'] = array(
      'default' => FALSE,
      'bool' => TRUE,
    );
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);

    // Add an option to remove search scores from the query.
    $form['remove_score'] = array(
      '#type' => 'checkbox',
      '#title' => t('Remove search score'),
      '#description' => t('Check this box to remove the search score from the query. This can help reduce duplicate search results when using this filter.'),
      '#default_value' => $this->options['remove_score'],
    );
  }

  /**
   * Provide simple equality operator.
   */
  public function operator_form(&$form, &$form_state) {
    $form['operator'] = array(
      '#type' => 'radios',
      '#title' => t('On empty input'),
      '#default_value' => $this->operator,
      '#options' => array(
        'optional' => t('Show All'),
        'required' => t('Show None'),
      ),
    );
  }

  /**
   * Provide a simple textfield for equality.
   */
  public function value_form(&$form, &$form_state) {
    $form['value'] = array(
      '#type' => 'textfield',
      '#size' => 15,
      '#default_value' => $this->value,
      '#attributes' => array(
        'title' => t('Enter the terms you wish to search for.'),
      ),
      '#title' => empty($form_state['exposed']) ? t('Value') : '',
    );
  }

  /**
   * Validate the options form.
   */
  public function exposed_validate(&$form, &$form_state) {
    if (!isset($this->options['expose']['identifier'])) {
      return;
    }
    $key = $this->options['expose']['identifier'];
    if (!empty($form_state['values'][$key])) {
      $this
        ->query_parse_search_expression($form_state['values'][$key]);
      if (count($this->search_query
        ->words()) == 0) {
        form_set_error($key, format_plural(variable_get('minimum_word_size', 3), 'You must include at least one positive keyword with 1 character or more.', 'You must include at least one positive keyword with @count characters or more.'));
      }
    }
  }

  /**
   * Make sure that parseSearchExpression is run and everything is set up.
   *
   * @param string $input
   *    The search phrase which was input by the user.
   */
  public function query_parse_search_expression($input) {
    if (!isset($this->search_query)) {
      $this->parsed = TRUE;
      $this->search_query = db_select('search_index', 'i', array(
        'target' => 'slave',
      ))
        ->extend('viewsSearchQuery');
      $this->search_query
        ->searchExpression($input, $this->view->base_table);
      $this->search_query
        ->publicParseSearchExpression();
    }
  }

  /**
   * Add this filter to the query.
   *
   * Due to the nature of fapi, the value and the operator have an unintended
   * level of indirection. You will find them in $this->operator
   * and $this->value respectively.
   */
  public function query() {

    // Since attachment views don't validate the exposed input, parse the search
    // expression if required.
    if (!$this->parsed) {
      $this
        ->query_parse_search_expression($this->value);
    }
    $required = FALSE;
    if (!isset($this->search_query)) {
      $required = TRUE;
    }
    else {
      $words = $this->search_query
        ->words();
      if (empty($words)) {
        $required = TRUE;
      }
    }
    if ($required) {
      if ($this->operator == 'required') {
        $this->query
          ->add_where($this->options['group'], 'FALSE');
      }
    }
    else {
      $search_index = $this
        ->ensure_my_table();
      $search_condition = db_and();
      if (!$this->options['remove_score']) {

        // Create a new join to relate the 'serach_total' table to our current
        // 'search_index' table.
        $join = new views_join();
        $join
          ->construct('search_total', $search_index, 'word', 'word');
        $search_total = $this->query
          ->add_relationship('search_total', $join, $search_index);
        $this->search_score = $this->query
          ->add_field('', "{$search_index}.score * {$search_total}.count", 'score', array(
          'aggregate' => TRUE,
          'function' => 'sum',
        ));
      }
      if (empty($this->query->relationships[$this->relationship])) {
        $base_table = $this->query->base_table;
      }
      else {
        $base_table = $this->query->relationships[$this->relationship]['base'];
      }
      $search_condition
        ->condition("{$search_index}.type", $base_table);
      if (!$this->search_query
        ->simple()) {
        $search_dataset = $this->query
          ->add_table('search_dataset');
        $conditions = $this->search_query
          ->conditions();
        $condition_conditions =& $conditions
          ->conditions();
        foreach ($condition_conditions as $key => &$condition) {

          // Take sure we just look at real conditions.
          if (is_numeric($key)) {

            // Replace the conditions with the table alias of views.
            $this->search_query
              ->condition_replace_string('d.', "{$search_dataset}.", $condition);
          }
        }
        $search_conditions =& $search_condition
          ->conditions();
        $search_conditions = array_merge($search_conditions, $condition_conditions);
      }
      else {

        // Stores each condition, so and/or on the filter level will still work.
        $or = db_or();
        foreach ($words as $word) {
          $or
            ->condition("{$search_index}.word", $word);
        }
        $search_condition
          ->condition($or);
      }
      $this->query
        ->add_where($this->options['group'], $search_condition);
      $this->query
        ->add_groupby("{$search_index}.sid");
      $matches = $this->search_query
        ->matches();
      $placeholder = $this
        ->placeholder();
      $this->query
        ->add_having_expression($this->options['group'], "COUNT(*) >= {$placeholder}", array(
        $placeholder => $matches,
      ));
    }

    // Set to NULL to prevent PDO exception when views object is cached.
    $this->search_query = NULL;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
views_handler::$handler_type public property The type of the handler, for example filter/footer/field.
views_handler::$query public property Where the $query object will reside:. 1
views_handler::$real_field public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
views_handler::$relationship public property The relationship used for this field.
views_handler::$table_alias public property The alias of the table of this handler which is used in the query.
views_handler::$view public property The top object of a view. Overrides views_object::$view
views_handler::access public function Check whether current user has access to this handler. 10
views_handler::broken public function Determine if the handler is considered 'broken'. 6
views_handler::case_transform public function Transform a string by a certain method.
views_handler::ensure_my_table public function Ensure the main table for this handler is in the query. This is used a lot. 8
views_handler::exposed_submit public function Submit the exposed handler form.
views_handler::expose_submit public function Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data.
views_handler::extra_options public function Provide defaults for the handler.
views_handler::extra_options_form public function Provide a form for setting options. 1
views_handler::extra_options_submit public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
views_handler::extra_options_validate public function Validate the options form.
views_handler::get_field public function Shortcut to get a handler's raw field value.
views_handler::get_join public function Get the join object that should be used for this handler.
views_handler::groupby_form public function Provide a form for aggregation settings. 1
views_handler::groupby_form_submit public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. 1
views_handler::has_extra_options public function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. 1
views_handler::is_exposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::needs_style_plugin public function Determine if the argument needs a style plugin. 1
views_handler::placeholder public function Provides a unique placeholders for handlers.
views_handler::post_execute public function Run after the view is executed, before the result is cached. 1
views_handler::pre_query public function Run before the view is built. 1
views_handler::sanitize_value public function Sanitize the value for output.
views_handler::set_relationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::show_expose_form public function Shortcut to display the exposed options form.
views_handler::ui_name public function Return a string representing this handler's name in the UI. 9
views_handler::use_group_by public function Provides the handler some groupby. 2
views_handler::validate public function Validates the handler against the complete View. 1
views_handler_filter::$always_required public property Disable the possibility to allow a exposed input to be optional.
views_handler_filter::$group_info public property Contains the information of the selected item in a gruped filter.
views_handler_filter::$no_operator public property Disable the possibility to use operators. 2
views_handler_filter::$operator public property Contains the operator which is used on the query.
views_handler_filter::$value public property Contains the actual value of the field.
views_handler_filter::accept_exposed_input public function Check to see if input from the exposed filters should change the behavior. Overrides views_handler::accept_exposed_input 2
views_handler_filter::admin_summary public function Display the filter on the administrative summary. Overrides views_handler::admin_summary 10
views_handler_filter::build_group_form public function Build the form to let users create the group of exposed filters.
views_handler_filter::build_group_options public function Provide default options for exposed filters.
views_handler_filter::build_group_submit public function Save new group items, re-enumerates and remove groups marked to delete.
views_handler_filter::build_group_validate public function Validate the build group options form. 1
views_handler_filter::can_build_group public function Determine if a filter can be converted into a group.
views_handler_filter::can_expose public function Determine if a filter can be exposed. Overrides views_handler::can_expose 5
views_handler_filter::can_group public function Can this filter be used in OR groups? 1
views_handler_filter::convert_exposed_input public function Transform the input from a grouped filter into a standard filter.
views_handler_filter::exposed_form public function Render our chunk of the exposed filter form when selecting. Overrides views_handler::exposed_form
views_handler_filter::exposed_info public function Tell the renderer about our exposed form. Overrides views_handler::exposed_info
views_handler_filter::exposed_translate public function Make some translations to a form item to make it more suitable to exposing.
views_handler_filter::expose_form public function Options form subform for exposed filter options. Overrides views_handler::expose_form 2
views_handler_filter::expose_options public function Provide default options for exposed filters. Overrides views_handler::expose_options 2
views_handler_filter::expose_validate public function Validate the options form. Overrides views_handler::expose_validate
views_handler_filter::group_form public function Build a form with a group of operator | values to apply as a single filter.
views_handler_filter::group_multiple_exposed_input public function Options available for a grouped filter which uses checkboxes.
views_handler_filter::init public function Provide some extra help to get the operator/value easier to use. Overrides views_handler::init 2
views_handler_filter::is_a_group public function Returns TRUE if the exposed filter works like a grouped filter. Overrides views_handler::is_a_group
views_handler_filter::multiple_exposed_input public function Indicate whether users can select multiple group items. Overrides views_handler::multiple_exposed_input
views_handler_filter::operator_options public function Provide a list of options for the default operator form. 4
views_handler_filter::operator_submit public function Perform any necessary changes to the form values prior to storage.
views_handler_filter::operator_validate public function Validate the operator form.
views_handler_filter::options_submit public function Simple submit handler. Overrides views_handler::options_submit
views_handler_filter::options_validate public function Simple validate handler. Overrides views_handler::options_validate 1
views_handler_filter::prepare_filter_select_options public function Sanitizes the HTML select element's options.
views_handler_filter::show_build_group_button public function Shortcut to display the build_group/hide button.
views_handler_filter::show_build_group_form public function Shortcut to display the exposed options form.
views_handler_filter::show_expose_button public function Shortcut to display the expose/hide button. Overrides views_handler::show_expose_button
views_handler_filter::show_operator_form public function Shortcut to display the operator form.
views_handler_filter::show_value_form public function Shortcut to display the value form.
views_handler_filter::store_exposed_input public function Store the exposed input for processing later. Overrides views_handler::store_exposed_input
views_handler_filter::store_group_input public function If set to remember exposed input in the session, store it there.
views_handler_filter::value_submit public function Perform any necessary changes to the form values prior to storage. 1
views_handler_filter::value_validate public function Validate the options form. 3
views_handler_filter_search::$always_multiple public property Disable the possibility to force a single value. Overrides views_handler_filter::$always_multiple
views_handler_filter_search::$parsed public property Checks if the search query has been parsed.
views_handler_filter_search::$search_query public property Stores a viewsSearchQuery object to be able to use the search.module "api".
views_handler_filter_search::exposed_validate public function Validate the options form. Overrides views_handler::exposed_validate
views_handler_filter_search::operator_form public function Provide simple equality operator. Overrides views_handler_filter::operator_form
views_handler_filter_search::options_form public function Provide the basic form which calls through to subforms. Overrides views_handler_filter::options_form
views_handler_filter_search::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_handler_filter::option_definition
views_handler_filter_search::query public function Add this filter to the query. Overrides views_handler_filter::query
views_handler_filter_search::query_parse_search_expression public function Make sure that parseSearchExpression is run and everything is set up.
views_handler_filter_search::value_form public function Provide a simple textfield for equality. Overrides views_handler_filter::value_form
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::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