class Search
Same name in this branch
- 11.x core/modules/search/src/Plugin/views/filter/Search.php \Drupal\search\Plugin\views\filter\Search
- 11.x core/lib/Drupal/Core/Render/Element/Search.php \Drupal\Core\Render\Element\Search
- 11.x core/modules/search/src/Attribute/Search.php \Drupal\search\Attribute\Search
Same name in other branches
- 9 core/modules/search/src/Plugin/views/filter/Search.php \Drupal\search\Plugin\views\filter\Search
- 9 core/modules/search/src/Plugin/views/argument/Search.php \Drupal\search\Plugin\views\argument\Search
- 9 core/lib/Drupal/Core/Render/Element/Search.php \Drupal\Core\Render\Element\Search
- 8.9.x core/modules/search/src/Plugin/views/filter/Search.php \Drupal\search\Plugin\views\filter\Search
- 8.9.x core/modules/search/src/Plugin/views/argument/Search.php \Drupal\search\Plugin\views\argument\Search
- 8.9.x core/lib/Drupal/Core/Render/Element/Search.php \Drupal\Core\Render\Element\Search
- 10 core/modules/search/src/Plugin/views/filter/Search.php \Drupal\search\Plugin\views\filter\Search
- 10 core/modules/search/src/Plugin/views/argument/Search.php \Drupal\search\Plugin\views\argument\Search
- 10 core/lib/Drupal/Core/Render/Element/Search.php \Drupal\Core\Render\Element\Search
- 10 core/modules/search/src/Attribute/Search.php \Drupal\search\Attribute\Search
Argument handler for search keywords.
Hierarchy
- class \Drupal\search\Plugin\views\argument\Search extends \Drupal\views\Plugin\views\argument\ArgumentPluginBase
Expanded class hierarchy of Search
Related topics
106 string references to 'Search'
- AddHandler::buildForm in core/
modules/ views_ui/ src/ Form/ Ajax/ AddHandler.php - AjaxFormCacheTest::testBlockForms in core/
tests/ Drupal/ FunctionalJavascriptTests/ Ajax/ AjaxFormCacheTest.php - Tests AJAX forms in blocks.
- block.block.claro_help_search.yml in core/
modules/ help/ config/ optional/ block.block.claro_help_search.yml - core/modules/help/config/optional/block.block.claro_help_search.yml
- block.block.olivero_search_form_narrow.yml in core/
themes/ olivero/ config/ optional/ block.block.olivero_search_form_narrow.yml - core/themes/olivero/config/optional/block.block.olivero_search_form_narrow.yml
- block.block.olivero_search_form_wide.yml in core/
themes/ olivero/ config/ optional/ block.block.olivero_search_form_wide.yml - core/themes/olivero/config/optional/block.block.olivero_search_form_wide.yml
File
-
core/
modules/ search/ src/ Plugin/ views/ argument/ Search.php, line 17
Namespace
Drupal\search\Plugin\views\argumentView source
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;
/**
* The search score.
*/
// phpcs:ignore Drupal.NamingConventions.ValidVariableName.LowerCamelName, Drupal.Commenting.VariableComment.Missing
public string $search_score;
/**
* {@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
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ArgumentPluginBase::$argument | public | property | |||
ArgumentPluginBase::$argument_validated | public | property | |||
ArgumentPluginBase::$base_alias | public | property | |||
ArgumentPluginBase::$count_alias | public | property | |||
ArgumentPluginBase::$is_default | public | property | |||
ArgumentPluginBase::$name_alias | public | property | |||
ArgumentPluginBase::$name_field | public | property | |||
ArgumentPluginBase::$name_table | public | property | |||
ArgumentPluginBase::$name_table_alias | public | property | |||
ArgumentPluginBase::$operator | public | property | The operator used for the query: or|and. | ||
ArgumentPluginBase::$tableAliases | public | property | Keyed array by alias of table relations. | ||
ArgumentPluginBase::$validated_title | public | property | |||
ArgumentPluginBase::$validator | public | property | |||
ArgumentPluginBase::$value | public | property | 1 | ||
ArgumentPluginBase::adminSummary | public | function | Overrides HandlerBase::adminSummary | ||
ArgumentPluginBase::buildOptionsForm | public | function | Overrides HandlerBase::buildOptionsForm | 6 | |
ArgumentPluginBase::calculateDependencies | public | function | 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 | Default actions. | 3 | |
ArgumentPluginBase::defaultArgumentForm | public | function | Provides a form for selecting the default argument. | 1 | |
ArgumentPluginBase::defaultDefault | protected | function | Returns true, since the argument builder knows where to find the argument. | ||
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 | Provides a form for selecting summary options. | ||
ArgumentPluginBase::defineOptions | protected | function | 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 | Overrides CacheableDependencyInterface::getCacheContexts | ||
ArgumentPluginBase::getCacheMaxAge | public | function | Overrides CacheableDependencyInterface::getCacheMaxAge | ||
ArgumentPluginBase::getCacheTags | public | function | 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 | Determines the title to use for the view. | ||
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 | Overrides PluginBase::submitOptionsForm | ||
ArgumentPluginBase::summaryArgument | public | function | Provides the argument to use to link from the summary to the next level. | 4 | |
ArgumentPluginBase::summaryBasics | public | function | Adds basic information to the summary query. | ||
ArgumentPluginBase::summaryName | public | function | Provides the name to use for the summary, defaults to the name field. | 9 | |
ArgumentPluginBase::summaryNameField | protected | function | Adds the name field, which is the field displayed in summary queries. | ||
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. | ||
ArgumentPluginBase::title | public | function | Get the title this argument will assign the view, given the argument. | 10 | |
ArgumentPluginBase::trustedCallbacks | public static | function | 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 | Overrides PluginBase::validateOptionsForm | ||
DerivativeInspectionInterface::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | 1 | |
DerivativeInspectionInterface::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | 1 | |
HandlerBase::$field | public | property | With field you can override the realField if the real field is not set. | ||
HandlerBase::$is_handler | public | property | |||
HandlerBase::$moduleHandler | protected | property | The module handler. | 2 | |
HandlerBase::$query | public | property | Where the $query object will reside. | 7 | |
HandlerBase::$realField | public | property | The real field. | ||
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 | Overrides ViewsHandlerInterface::access | 5 | |
HandlerBase::adminLabel | public | function | Overrides ViewsHandlerInterface::adminLabel | 4 | |
HandlerBase::breakString | public static | function | Overrides ViewsHandlerInterface::breakString | ||
HandlerBase::broken | public | function | 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. | 2 | |
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 | 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 | Overrides ViewsHandlerInterface::getEntityType | ||
HandlerBase::getField | public | function | Overrides ViewsHandlerInterface::getField | ||
HandlerBase::getJoin | public | function | Overrides ViewsHandlerInterface::getJoin | ||
HandlerBase::getModuleHandler | protected | function | Gets the module handler. | ||
HandlerBase::getTableJoin | public static | function | Overrides ViewsHandlerInterface::getTableJoin | ||
HandlerBase::getViewsData | protected | function | Gets views data service. | ||
HandlerBase::hasExtraOptions | public | function | Determines if the handler has extra options. | 2 | |
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'. | ||
HandlerBase::multipleExposedInput | public | function | Define if the exposed input has to be submitted multiple times. | 1 | |
HandlerBase::placeholder | protected | function | Provides a unique placeholders for handlers. | ||
HandlerBase::postExecute | public | function | Overrides ViewsHandlerInterface::postExecute | ||
HandlerBase::preQuery | public | function | Overrides ViewsHandlerInterface::preQuery | 2 | |
HandlerBase::sanitizeValue | public | function | Overrides ViewsHandlerInterface::sanitizeValue | ||
HandlerBase::setModuleHandler | public | function | Sets the module handler. | ||
HandlerBase::setRelationship | public | function | 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. | ||
HandlerBase::submitExtraOptionsForm | public | function | Perform any necessary changes to the form values prior to storage. | 1 | |
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. | 1 | |
HandlerBase::submitTemporaryForm | public | function | Submits a temporary form. | ||
HandlerBase::usesGroupBy | public | function | Provides the handler some groupby. | 13 | |
HandlerBase::validate | public | function | Overrides PluginBase::validate | 2 | |
HandlerBase::validateExposed | public | function | Validate the exposed handler form. | 5 | |
HandlerBase::validateExposeForm | public | function | Validate the options form. | 2 | |
HandlerBase::validateExtraOptionsForm | public | function | Validate the options form. | 1 | |
HandlerBase::__construct | public | function | Constructs a Handler object. | Overrides PluginBase::__construct | 43 |
PluginBase::$definition | public | property | Plugins' 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::$position | public | property | The handler position. | ||
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 | Overrides ContainerFactoryPluginInterface::create | 61 | |
PluginBase::destroy | public | function | 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 | Overrides ViewsPluginInterface::filterByDefinedOptions | ||
PluginBase::getAvailableGlobalTokens | public | function | Overrides ViewsPluginInterface::getAvailableGlobalTokens | ||
PluginBase::getProvider | public | function | Overrides ViewsPluginInterface::getProvider | ||
PluginBase::getRenderer | protected | function | Returns the render API renderer. | 1 | |
PluginBase::globalTokenForm | public | function | Overrides ViewsPluginInterface::globalTokenForm | ||
PluginBase::globalTokenReplace | public | function | 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::listLanguages | protected | function | Makes an array of languages, optionally including special languages. | ||
PluginBase::pluginTitle | public | function | Overrides ViewsPluginInterface::pluginTitle | ||
PluginBase::preRenderAddFieldsetMarkup | public static | function | Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup | ||
PluginBase::preRenderFlattenData | public static | function | 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 | Overrides ViewsPluginInterface::summaryTitle | 6 | |
PluginBase::themeFunctions | public | function | Overrides ViewsPluginInterface::themeFunctions | 1 | |
PluginBase::unpackOptions | public | function | Overrides ViewsPluginInterface::unpackOptions | ||
PluginBase::usesOptions | public | function | Overrides ViewsPluginInterface::usesOptions | 8 | |
PluginBase::viewsTokenReplace | protected | function | Replaces Views' tokens in a given string. | 1 | |
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT | constant | Query string to indicate the site default language. | |||
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 2 | |
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::$search_score | public | property | |||
Search::init | public | function | Overrides ArgumentPluginBase::init | ||
Search::query | public | function | Overrides ArgumentPluginBase::query | ||
Search::queryParseSearchExpression | protected | function | Sets up and parses the search query. | ||
TrustedCallbackInterface::THROW_EXCEPTION | constant | Untrusted callbacks throw exceptions. | |||
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION | constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.