class Search in Drupal 9

Argument handler for search keywords.

Plugin annotation

@ViewsArgument("search");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
      • class \Drupal\views\Plugin\views\HandlerBase implements ViewsHandlerInterface
        • class \Drupal\views\Plugin\views\argument\ArgumentPluginBase implements CacheableDependencyInterface
          • class \Drupal\search\Plugin\views\argument\Search

Related topics

Views argument handlers

Handler plugins for Views contextual filters.

45 string references to 'Search'

AddHandler::buildForm in core/modules/views_ui/src/Form/Ajax/AddHandler.php

Form constructor.

block.block.bartik_search.yml in core/profiles/standard/config/install/block.block.bartik_search.yml

core/profiles/standard/config/install/block.block.bartik_search.yml

block.block.umami_search.yml in core/profiles/demo_umami/config/install/block.block.umami_search.yml

core/profiles/demo_umami/config/install/block.block.umami_search.yml

BlockHiddenRegionTest::testBlockNotInHiddenRegion in core/modules/block/tests/src/Functional/BlockHiddenRegionTest.php

Tests that hidden regions do not inherit blocks when a theme is installed.

ConfigTranslationEntityListBuilder::render in core/modules/config_translation/src/Controller/ConfigTranslationEntityListBuilder.php

Builds a listing of entities for the given entity type.

... See full list

File

core/modules/search/src/Plugin/views/argument/Search.php, line 18

Namespace

Drupal\search\Plugin\views\argument

class Search extends ArgumentPluginBase {

  /**
   * A search query to use for parsing search keywords.
   *
   * @var \Drupal\search\ViewsSearchQuery
   */
  protected $searchQuery = NULL;

  /**
   * The search type name (value of {search_index}.type in the database).
   *
   * @var string
   */
  protected $searchType;

  /**
   * {@inheritdoc}
   */
  public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
    parent::init($view, $display, $options);
    $this->searchType = $this->definition['search_type'];
  }

  /**
   * Sets up and parses the search query.
   *
   * @param string $input
   *   The search keywords entered by the user.
   */
  protected function queryParseSearchExpression($input) {
    if (!isset($this->searchQuery)) {
      $this->searchQuery = \Drupal::service('database.replica')
        ->select('search_index', 'i')
        ->extend(ViewsSearchQuery::class);
      $this->searchQuery
        ->searchExpression($input, $this->searchType);
      $this->searchQuery
        ->publicParseSearchExpression();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function query($group_by = FALSE) {
    $required = FALSE;
    $this
      ->queryParseSearchExpression($this->argument);
    if (!isset($this->searchQuery)) {
      $required = TRUE;
    }
    else {
      $words = $this->searchQuery
        ->words();
      if (empty($words)) {
        $required = TRUE;
      }
    }
    if ($required) {
      if ($this->operator == 'required') {
        $this->query
          ->addWhere(0, 'FALSE');
      }
    }
    else {
      $search_index = $this
        ->ensureMyTable();
      $search_condition = $this->view->query
        ->getConnection()
        ->condition('AND');

      // Create a new join to relate the 'search_total' table to our current 'search_index' table.
      $definition = [
        'table' => 'search_total',
        'field' => 'word',
        'left_table' => $search_index,
        'left_field' => 'word',
      ];
      $join = Views::pluginManager('join')
        ->createInstance('standard', $definition);
      $search_total = $this->query
        ->addRelationship('search_total', $join, $search_index);

      // Add the search score field to the query.
      $this->search_score = $this->query
        ->addField('', "{$search_index}.score * {$search_total}.count", 'score', [
        'function' => 'sum',
      ]);

      // Add the conditions set up by the search query to the views query.
      $search_condition
        ->condition("{$search_index}.type", $this->searchType);
      $search_dataset = $this->query
        ->addTable('node_search_dataset');
      $conditions = $this->searchQuery
        ->conditions();
      $condition_conditions =& $conditions
        ->conditions();
      foreach ($condition_conditions as $key => &$condition) {

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

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

      // Add the keyword conditions, as is done in
      // SearchQuery::prepareAndNormalize(), but simplified because we are
      // only concerned with relevance ranking so we do not need to normalize.
      $or = $this->view->query
        ->getConnection()
        ->condition('OR');
      foreach ($words as $word) {
        $or
          ->condition("{$search_index}.word", $word);
      }
      $search_condition
        ->condition($or);

      // Add the GROUP BY and HAVING expressions to the query.
      $this->query
        ->addWhere(0, $search_condition);
      $this->query
        ->addGroupBy("{$search_index}.sid");
      $matches = $this->searchQuery
        ->matches();
      $placeholder = $this
        ->placeholder();
      $this->query
        ->addHavingExpression(0, "COUNT(*) >= {$placeholder}", [
        $placeholder => $matches,
      ]);
    }

    // Set to NULL to prevent PDO exception when views object is cached
    // and to clear out memory.
    $this->searchQuery = NULL;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ArgumentPluginBase::$argument	public	property
ArgumentPluginBase::$name_field	public	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	public	property	The table to use for the name, should it not be in the same table as the argument.
ArgumentPluginBase::$validator	public	property
ArgumentPluginBase::$value	public	property		1
ArgumentPluginBase::buildOptionsForm	public	function	Provide a form to edit options for this plugin. Overrides HandlerBase::buildOptionsForm	6
ArgumentPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides HandlerBase::calculateDependencies
ArgumentPluginBase::decodeValidatorId	public static	function	Revert sanitized validator options.
ArgumentPluginBase::defaultAccessDenied	public	function	Default action: access denied.
ArgumentPluginBase::defaultAction	public	function	Handle the default action, which means our argument wasn't present.
ArgumentPluginBase::defaultActions	protected	function	Provide a list of default behaviors for this argument if the argument is not present.	3
ArgumentPluginBase::defaultArgumentForm	public	function	Provide a form for selecting the default argument when the default action is set to provide default argument.	1
ArgumentPluginBase::defaultDefault	protected	function	This just returns true. The view argument builder will know where to find the argument from.
ArgumentPluginBase::defaultEmpty	public	function	Default action: empty.
ArgumentPluginBase::defaultIgnore	public	function	Default action: ignore.
ArgumentPluginBase::defaultNotFound	protected	function	Default action: not found.
ArgumentPluginBase::defaultSummary	protected	function	Default action: summary.
ArgumentPluginBase::defaultSummaryForm	public	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. Overrides HandlerBase::defineOptions	5
ArgumentPluginBase::encodeValidatorId	public static	function	Sanitize validator options including derivatives with : for js.
ArgumentPluginBase::exceptionTitle	public	function
ArgumentPluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
ArgumentPluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
ArgumentPluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
ArgumentPluginBase::getContextDefinition	public	function	Returns a context definition for this argument.	2
ArgumentPluginBase::getDefaultArgument	public	function	Get a default argument, if available.	1
ArgumentPluginBase::getPlugin	public	function	Get the display or row plugin, if it exists.
ArgumentPluginBase::getSortName	public	function	Return a description of how the argument would normally be sorted.	5
ArgumentPluginBase::getTitle	public	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::getTokenHelp	protected	function	Provide token help information for the argument.
ArgumentPluginBase::getValue	public	function	Get the value of this argument.
ArgumentPluginBase::hasDefaultArgument	public	function	Determine if the argument is set to provide a default argument.
ArgumentPluginBase::isException	public	function
ArgumentPluginBase::needsStylePlugin	public	function	Determine if the argument needs a style plugin.
ArgumentPluginBase::preRenderMoveArgumentOptions	public static	function	Moves argument options into their place.
ArgumentPluginBase::processContainerRadios	public static	function	Custom form radios process function.
ArgumentPluginBase::processSummaryArguments	public	function	Process the summary arguments for display.
ArgumentPluginBase::setArgument	public	function	Set the input for this argument.
ArgumentPluginBase::submitOptionsForm	public	function	Handle any special handling on the validate form. Overrides PluginBase::submitOptionsForm
ArgumentPluginBase::summaryArgument	public	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::summaryBasics	public	function	Some basic summary behavior that doesn't need to be repeated as much as code that goes into summaryQuery()
ArgumentPluginBase::summaryName	public	function	Provides the name to use for the summary. By default this is just the name field.	8
ArgumentPluginBase::summaryNameField	protected	function	Add the name field, which is the field displayed in summary queries. This is often used when the argument is numeric.
ArgumentPluginBase::summaryQuery	protected	function	Build the info for the summary query.	3
ArgumentPluginBase::summarySort	public	function	Sorts the summary based upon the user's selection. The base variant of this is usually adequate.
ArgumentPluginBase::title	public	function	Get the title this argument will assign the view, given the argument.	10
ArgumentPluginBase::trustedCallbacks	public static	function	Lists the trusted callbacks provided by the implementing class. Overrides PluginBase::trustedCallbacks
ArgumentPluginBase::unpackArgumentValue	protected	function	Splits an argument into value and operator properties on this instance.
ArgumentPluginBase::validateArgument	public	function	Validate that this argument works. By default, all arguments are valid.
ArgumentPluginBase::validateFail	public	function	How to act if validation fails.
ArgumentPluginBase::validateMenuArgument	public	function	Called by the menu system to validate an argument.
ArgumentPluginBase::validateOptionsForm	public	function	Validate the options form. Overrides PluginBase::validateOptionsForm
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
HandlerBase::$field	public	property	With field you can override the realField if the real field is not set.
HandlerBase::$moduleHandler	protected	property	The module handler.	3
HandlerBase::$query	public	property	Where the $query object will reside.	7
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::$viewsData	protected	property	The views data service.
HandlerBase::acceptExposedInput	public	function	Take input from exposed handlers and assign to this handler, if necessary.	1
HandlerBase::access	public	function	Check whether given user has access to this handler. Overrides ViewsHandlerInterface::access	4
HandlerBase::adminLabel	public	function	Return a string representing this handler's name in the UI. Overrides ViewsHandlerInterface::adminLabel	4
HandlerBase::adminSummary	public	function	Provide text for the administrative summary. Overrides ViewsHandlerInterface::adminSummary	4
HandlerBase::breakString	public static	function	Breaks x,y,z and x+y+z into an array. Overrides ViewsHandlerInterface::breakString
HandlerBase::broken	public	function	Determines if the handler is considered 'broken', meaning it's a placeholder used when a handler can't be found. Overrides ViewsHandlerInterface::broken
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::displayExposedForm	public	function	Displays the Expose form.
HandlerBase::ensureMyTable	public	function	Ensure the main table for this handler is in the query. This is used a lot. Overrides ViewsHandlerInterface::ensureMyTable	2
HandlerBase::exposedInfo	public	function	Get information about the exposed form for the form renderer.	1
HandlerBase::getDateField	public	function	Creates cross-database SQL dates.	2
HandlerBase::getDateFormat	public	function	Creates cross-database SQL date formatting.	2
HandlerBase::getEntityType	public	function	Determines the entity type used by this handler. Overrides ViewsHandlerInterface::getEntityType
HandlerBase::getField	public	function	Shortcut to get a handler's raw field value. Overrides ViewsHandlerInterface::getField
HandlerBase::getJoin	public	function	Get the join object that should be used for this handler. Overrides ViewsHandlerInterface::getJoin
HandlerBase::getModuleHandler	protected	function	Gets the module handler.
HandlerBase::getTableJoin	public static	function	Fetches a handler to join one table to a primary table from the data cache. Overrides ViewsHandlerInterface::getTableJoin
HandlerBase::getViewsData	protected	function	Gets views data service.
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. Overrides ViewsHandlerInterface::postExecute
HandlerBase::preQuery	public	function	Run before the view is built. Overrides ViewsHandlerInterface::preQuery	2
HandlerBase::sanitizeValue	public	function	Sanitize the value for output. Overrides ViewsHandlerInterface::sanitizeValue
HandlerBase::setModuleHandler	public	function	Sets the module handler.
HandlerBase::setRelationship	public	function	Called just prior to query(), this lets a handler set up any relationship it needs. Overrides ViewsHandlerInterface::setRelationship
HandlerBase::setViewsData	public	function
HandlerBase::showExposeButton	public	function	Shortcut to display the expose/hide button.	2
HandlerBase::showExposeForm	public	function	Shortcut to display the exposed options form. Overrides ViewsHandlerInterface::showExposeForm
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::submitFormCalculateOptions	public	function	Calculates options stored on the handler.	1
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::submitTemporaryForm	public	function	A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests.
HandlerBase::usesGroupBy	public	function	Provides the handler some groupby.	13
HandlerBase::validate	public	function	Validate that the plugin is correct and can be saved. Overrides PluginBase::validate	2
HandlerBase::validateExposed	public	function	Validate the exposed handler form.	4
HandlerBase::validateExposeForm	public	function	Validate the options form.	2
HandlerBase::validateExtraOptionsForm	public	function	Validate the options form.
HandlerBase::__construct	public	function	Constructs a Handler object. Overrides PluginBase::__construct	45
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
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::$renderer	protected	property	Stores the render API renderer.	3
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::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	63
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. Overrides ViewsPluginInterface::destroy	2
PluginBase::doFilterByDefinedOptions	protected	function	Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions	public	function	Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens	public	function	Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
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	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::getProvider	public	function	Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer	protected	function	Returns the render API renderer.	1
PluginBase::globalTokenForm	public	function	Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace	public	function	Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY		constant	Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED		constant	Include negotiated languages when listing languages.
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::listLanguages	protected	function	Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle	public	function	Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup	public static	function	Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData	public static	function	Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions	public static	function	Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults	protected	function	Fills up the options of the plugin with defaults.
PluginBase::summaryTitle	public	function	Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle	6
PluginBase::themeFunctions	public	function	Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions	1
PluginBase::unpackOptions	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions	public	function	Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions	8
PluginBase::viewsTokenReplace	protected	function	Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin.	1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT		constant	Query string to indicate the site default language.
Search::$searchQuery	protected	property	A search query to use for parsing search keywords.
Search::$searchType	protected	property	The search type name (value of {search_index}.type in the database).
Search::init	public	function	Overrides Drupal\views\Plugin\views\HandlerBase:init(). Overrides ArgumentPluginBase::init
Search::query	public	function	Set up the query for this argument. Overrides ArgumentPluginBase::query
Search::queryParseSearchExpression	protected	function	Sets up and parses the search query.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TrustedCallbackInterface::THROW_EXCEPTION		constant	Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION		constant	Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING		constant	Untrusted callbacks trigger E_USER_WARNING errors.