You are here

Home » API reference » Views (for Drupal 7) 8.3 » Search.php

class Search in Views (for Drupal 7) 8.3

Same name in this branch
  1. 8.3 lib/Views/search/Plugin/views/filter/Search.php \Views\search\Plugin\views\filter\Search
  2. 8.3 lib/Views/search/Plugin/views/argument/Search.php \Views\search\Plugin\views\argument\Search

Argument that accepts query keys for search.

Plugin annotation


@Plugin(
  id = "search",
  module = "search"
)

Hierarchy

Expanded class hierarchy of Search

Related topics

Views argument handlers
Handlers to tell Views how to contextually filter queries.
2 string references to 'Search'
search_views_data in modules/search.views.inc
Implements hook_views_data().
views_ui_add_item_form in views_ui/admin.inc
Form to add_item items in the views UI.

File

lib/Views/search/Plugin/views/argument/Search.php, line 23
Definition of Views\search\Plugin\views\argument\Search.

Namespace

Views\search\Plugin\views\argument
View source 
class Search extends ArgumentPluginBase {

  /**
   * Take sure that parseSearchExpression is runned and everything is set up for it.
   *
   * @param $input
   *    The search phrase which was input by the user.
   */
  function query_parse_search_expression($input) {
    if (!isset($this->search_query)) {
      $this->search_query = db_select('search_index', 'i', array(
        'target' => 'slave',
      ))
        ->extend('Views\\search\\ViewsSearchQuery');
      $this->search_query
        ->searchExpression($input, $this->view->base_table);
      $this->search_query
        ->publicParseSearchExpression();
    }
  }

  /**
   * Add this argument to the query.
   */
  public function query($group_by = FALSE) {
    $required = FALSE;
    $this
      ->query_parse_search_expression($this->argument);
    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(0, 'FALSE');
      }
    }
    else {
      $search_index = $this
        ->ensureMyTable();
      $search_condition = db_and();

      // Create a new join to relate the 'search_total' table to our current 'search_index' table.
      $definition = array(
        'table' => 'search_total',
        'field' => 'word',
        'left_table' => $search_index,
        'left_field' => 'word',
      );
      $join = drupal_container()
        ->get('plugin.manager.views.join')
        ->createInstance('standard', $definition);
      $search_total = $this->query
        ->add_relationship('search_total', $join, $search_index);
      $this->search_score = $this->query
        ->add_field('', "SUM({$search_index}.score * {$search_total}.count)", 'score', array(
        'aggregate' => TRUE,
      ));
      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(0, $search_condition);
      $this->query
        ->add_groupby("{$search_index}.sid");
      $matches = $this->search_query
        ->matches();
      $placeholder = $this
        ->placeholder();
      $this->query
        ->add_having_expression(0, "COUNT(*) >= {$placeholder}", array(
        $placeholder => $matches,
      ));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ArgumentPluginBase::$argument property
ArgumentPluginBase::$name_field property The field to use for the name to use in the summary, which is the displayed output. For example, for the node: nid argument, the argument itself is the nid, but node.title is displayed.
ArgumentPluginBase::$name_table property The table to use for the name, should it not be in the same table as the argument.
ArgumentPluginBase::$validator property
ArgumentPluginBase::$value property 1
ArgumentPluginBase::buildOptionsForm public function Build the options form. Overrides HandlerBase::buildOptionsForm 7
ArgumentPluginBase::default_access_denied function Default action: access denied.
ArgumentPluginBase::default_action function Handle the default action, which means our argument wasn't present.
ArgumentPluginBase::default_actions function Provide a list of default behaviors for this argument if the argument is not present. 3
ArgumentPluginBase::default_argument_form function Provide a form for selecting the default argument when the default action is set to provide default argument. 1
ArgumentPluginBase::default_default function This just returns true. The view argument builder will know where to find the argument from.
ArgumentPluginBase::default_empty function Default action: empty
ArgumentPluginBase::default_ignore function Default action: ignore.
ArgumentPluginBase::default_not_found function Default action: not found.
ArgumentPluginBase::default_summary function Default action: summary.
ArgumentPluginBase::default_summary_form function Provide a form for selecting further summary options when the default action is set to display one.
ArgumentPluginBase::defineOptions protected function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides HandlerBase::defineOptions 6
ArgumentPluginBase::exception_title function
ArgumentPluginBase::get_default_argument function Get a default argument, if available. 1
ArgumentPluginBase::get_plugin function Get the display or row plugin, if it exists.
ArgumentPluginBase::get_sort_name function Return a description of how the argument would normally be sorted. 5
ArgumentPluginBase::get_title function Called by the view object to get the title. This may be set by a validator so we don't necessarily call through to title().
ArgumentPluginBase::get_value function Get the value of this argument.
ArgumentPluginBase::has_default_argument function Determine if the argument is set to provide a default argument.
ArgumentPluginBase::init public function Overrides Drupal\views\Plugin\views\HandlerBase:init(). Overrides HandlerBase::init 4
ArgumentPluginBase::is_exception function
ArgumentPluginBase::needsStylePlugin public function Determine if the argument needs a style plugin.
ArgumentPluginBase::processContainerRadios public static function Custom form radios process function.
ArgumentPluginBase::process_summary_arguments function Process the summary arguments for display.
ArgumentPluginBase::set_argument function Set the input for this argument
ArgumentPluginBase::set_breadcrumb function Give an argument the opportunity to modify the breadcrumb, if it wants. This only gets called on displays where a breadcrumb is actually used. 2
ArgumentPluginBase::submitOptionsForm 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. Overrides HandlerBase::submitOptionsForm
ArgumentPluginBase::summary_argument function Provide the argument to use to link from the summary to the next level; this will be called once per row of a summary, and used as part of $view->getUrl(). 4
ArgumentPluginBase::summary_basics function Some basic summary behavior that doesn't need to be repeated as much as code that goes into summary_query()
ArgumentPluginBase::summary_name function Provides the name to use for the summary. By default this is just the name field. 8
ArgumentPluginBase::summary_name_field function Add the name field, which is the field displayed in summary queries. This is often used when the argument is numeric.
ArgumentPluginBase::summary_query function Build the info for the summary query. 3
ArgumentPluginBase::summary_sort function Sorts the summary based upon the user's selection. The base variant of this is usually adequte.
ArgumentPluginBase::title function Get the title this argument will assign the view, given the argument. 10
ArgumentPluginBase::uses_breadcrumb function Determine if the argument can generate a breadcrumb
ArgumentPluginBase::validateArgument public function Validate that this argument works. By default, all arguments are valid.
ArgumentPluginBase::validateFail public function How to act if validation failes
ArgumentPluginBase::validateOptionsForm public function Validate the options form. Overrides HandlerBase::validateOptionsForm
ArgumentPluginBase::validate_argument function Called by the menu system to validate an argument.
HandlerBase::$actualField public property When a field has been moved this property is set.
HandlerBase::$actualTable public property When a table has been moved this property is set.
HandlerBase::$field public property With field you can override the realField if the real field is not set.
HandlerBase::$query public property Where the $query object will reside: 1
HandlerBase::$realField public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
HandlerBase::$relationship public property The relationship used for this field.
HandlerBase::$table public property The table this handler is attached to.
HandlerBase::$tableAlias public property The alias of the table of this handler which is used in the query.
HandlerBase::acceptExposedInput public function Take input from exposed handlers and assign to this handler, if necessary. 1
HandlerBase::access public function Check whether current user has access to this handler. 7
HandlerBase::adminLabel public function Return a string representing this handler's name in the UI. 9
HandlerBase::adminSummary public function Provide text for the administrative summary 4
HandlerBase::breakPhrase public static function Breaks x,y,z and x+y+z into an array. Numeric only.
HandlerBase::breakPhraseString public static function Breaks x,y,z and x+y+z into an array. Works for strings.
HandlerBase::broken public function Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. 6
HandlerBase::buildExposedForm public function Render our chunk of the exposed handler form when selecting 1
HandlerBase::buildExposeForm public function Form for exposed handler options. 2
HandlerBase::buildExtraOptionsForm public function Provide a form for setting options. 1
HandlerBase::buildGroupByForm public function Provide a form for aggregation settings. 1
HandlerBase::canExpose public function Determine if a handler can be exposed. 2
HandlerBase::caseTransform protected function Transform a string by a certain method.
HandlerBase::defaultExposeOptions public function Set new exposed option defaults when exposed setting is flipped on. 2
HandlerBase::defineExtraOptions public function Provide defaults for the handler.
HandlerBase::ensureMyTable public function Ensure the main table for this handler is in the query. This is used a lot. 8
HandlerBase::exposedInfo public function Get information about the exposed form for the form renderer. 1
HandlerBase::getField public function Shortcut to get a handler's raw field value.
HandlerBase::getJoin public function Get the join object that should be used for this handler.
HandlerBase::getSQLDateField public function Creates cross-database SQL dates.
HandlerBase::getSQLFormat public function Creates cross-database SQL date formatting.
HandlerBase::getTableJoin public static function Fetches a handler to join one table to a primary table from the data cache.
HandlerBase::getTimezone public static function Figure out what timezone we're in; needed for some date manipulations.
HandlerBase::hasExtraOptions public function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. 1
HandlerBase::isAGroup public function Returns TRUE if the exposed filter works like a grouped filter. 1
HandlerBase::isExposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
HandlerBase::multipleExposedInput public function Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. 1
HandlerBase::placeholder protected function Provides a unique placeholders for handlers.
HandlerBase::postExecute public function Run after the view is executed, before the result is cached.
HandlerBase::preQuery public function Run before the view is built. 1
HandlerBase::sanitizeValue protected function Sanitize the value for output.
HandlerBase::setRelationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
HandlerBase::showExposeButton public function Shortcut to display the expose/hide button. 2
HandlerBase::showExposeForm public function Shortcut to display the exposed options form.
HandlerBase::storeExposedInput public function If set to remember exposed input in the session, store it there. 1
HandlerBase::submitExposed public function Submit the exposed handler form
HandlerBase::submitExposeForm 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.
HandlerBase::submitExtraOptionsForm 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.
HandlerBase::submitGroupByForm 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
HandlerBase::usesGroupBy public function Provides the handler some groupby. 2
HandlerBase::validate public function Validates the handler against the complete View. Overrides PluginBase::validate 1
HandlerBase::validateExposed public function Validate the exposed handler form 4
HandlerBase::validateExposeForm public function Validate the options form. 1
HandlerBase::validateExtraOptionsForm public function Validate the options form.
HandlerBase::__construct public function Constructs a Handler object. Overrides PluginBase::__construct
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's definition
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
PluginBase::$view public property The top object of a view. 1
PluginBase::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function Clears a plugin. 2
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::setOptionDefaults protected function
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions public function Returns the usesOptions property. 8
Search::query public function Add this argument to the query. Overrides ArgumentPluginBase::query
Search::query_parse_search_expression function Take sure that parseSearchExpression is runned and everything is set up for it.