class Search
Same name in this branch
- 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
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
- 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
- 11.x core/modules/search/src/Plugin/views/filter/Search.php \Drupal\search\Plugin\views\filter\Search
- 11.x core/modules/search/src/Plugin/views/argument/Search.php \Drupal\search\Plugin\views\argument\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
- 10 core/modules/search/src/Attribute/Search.php \Drupal\search\Attribute\Search
Filter handler for search keywords.
Plugin annotation
@ViewsFilter("search_keywords");
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\views\Plugin\views\HandlerBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\ViewsHandlerInterface
- class \Drupal\views\Plugin\views\filter\FilterPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements \Drupal\Core\Cache\CacheableDependencyInterface
- class \Drupal\search\Plugin\views\filter\Search extends \Drupal\views\Plugin\views\filter\FilterPluginBase
- class \Drupal\views\Plugin\views\filter\FilterPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements \Drupal\Core\Cache\CacheableDependencyInterface
- class \Drupal\views\Plugin\views\HandlerBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\ViewsHandlerInterface
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of Search
Related topics
88 string references to 'Search'
- AddHandler::buildForm in core/
modules/ views_ui/ src/ Form/ Ajax/ AddHandler.php - Form constructor.
- AjaxFormCacheTest::testBlockForms in core/
tests/ Drupal/ FunctionalJavascriptTests/ Ajax/ AjaxFormCacheTest.php - Tests AJAX forms in blocks.
- 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.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.secondtestfor2354889.yml in core/
modules/ system/ tests/ fixtures/ update/ block.block.secondtestfor2354889.yml - core/modules/system/tests/fixtures/update/block.block.secondtestfor2354889.yml
File
-
core/
modules/ search/ src/ Plugin/ views/ filter/ Search.php, line 20
Namespace
Drupal\search\Plugin\views\filterView source
class Search extends FilterPluginBase {
/**
* This filter is always considered multiple-valued.
*
* @var bool
*/
protected $alwaysMultiple = TRUE;
/**
* A search query to use for parsing search keywords.
*
* @var \Drupal\search\ViewsSearchQuery
*/
protected $searchQuery = NULL;
/**
* TRUE if the search query has been parsed.
*
* @var bool
*/
protected $parsed = FALSE;
/**
* 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'];
}
/**
* {@inheritdoc}
*/
protected function defineOptions() {
$options = parent::defineOptions();
$options['operator']['default'] = 'optional';
return $options;
}
/**
* {@inheritdoc}
*/
protected function operatorForm(&$form, FormStateInterface $form_state) {
$form['operator'] = [
'#type' => 'radios',
'#title' => $this->t('On empty input'),
'#default_value' => $this->operator,
'#options' => [
'optional' => $this->t('Show All'),
'required' => $this->t('Show None'),
],
];
}
/**
* {@inheritdoc}
*/
protected function valueForm(&$form, FormStateInterface $form_state) {
$form['value'] = [
'#type' => 'textfield',
'#size' => 15,
'#default_value' => $this->value,
'#attributes' => [
'title' => $this->t('Search keywords'),
],
'#title' => !$form_state->get('exposed') ? $this->t('Keywords') : '',
];
}
/**
* {@inheritdoc}
*/
public function validateExposed(&$form, FormStateInterface $form_state) {
if (!isset($this->options['expose']['identifier'])) {
return;
}
$key = $this->options['expose']['identifier'];
if (!$form_state->isValueEmpty($key)) {
$this->queryParseSearchExpression($form_state->getValue($key));
if (count($this->searchQuery
->words()) == 0) {
$form_state->setErrorByName($key, $this->formatPlural(\Drupal::config('search.settings')->get('index.minimum_word_size'), 'You must include at least one keyword to match in the content, and punctuation is ignored.', 'You must include at least one keyword to match in the content. Keywords must be at least @count characters, and punctuation is ignored.'));
}
}
}
/**
* 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->parsed = TRUE;
$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() {
// Since attachment views don't validate the exposed input, parse the search
// expression if required.
if (!$this->parsed) {
$this->queryParseSearchExpression($this->value);
}
$required = FALSE;
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($this->options['group'], 'FALSE');
}
}
else {
$search_index = $this->ensureMyTable();
$search_condition = new 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 = new Condition('OR');
foreach ($words as $word) {
$or->condition("{$search_index}.word", $word);
}
$search_condition->condition($or);
$this->query
->addWhere($this->options['group'], $search_condition);
// Add the GROUP BY and HAVING expressions to the query.
$this->query
->addGroupBy("{$search_index}.sid");
$matches = $this->searchQuery
->matches();
$placeholder = $this->placeholder();
$this->query
->addHavingExpression($this->options['group'], "COUNT(*) >= {$placeholder}", [
$placeholder => $matches,
]);
}
// Set to NULL to prevent PDO exception when views object is cached.
$this->searchQuery = NULL;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
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 | |
FilterPluginBase::$always_required | public | property | Disable the possibility to allow a exposed input to be optional. | ||
FilterPluginBase::$group_info | public | property | Contains the information of the selected item in a grouped filter. | ||
FilterPluginBase::$no_operator | public | property | Disable the possibility to use operators. | 1 | |
FilterPluginBase::$operator | public | property | Contains the operator which is used on the query. | ||
FilterPluginBase::$value | public | property | Contains the actual value of the field,either configured in the views ui or entered in the exposed filters. |
||
FilterPluginBase::acceptExposedInput | public | function | Determines if the input from a filter should change the generated query. | Overrides HandlerBase::acceptExposedInput | 2 |
FilterPluginBase::addGroupForm | public | function | Add a new group to the exposed filter groups. | ||
FilterPluginBase::adminSummary | public | function | Display the filter on the administrative summary | Overrides HandlerBase::adminSummary | 10 |
FilterPluginBase::arrayFilterZero | protected static | function | Filter by no empty values, though allow the use of (string) "0". | ||
FilterPluginBase::buildExposedFiltersGroupForm | protected | function | Build the form to let users create the group of exposed filters. This form is displayed when users click on button 'Build group' |
||
FilterPluginBase::buildExposedForm | public | function | Render our chunk of the exposed filter form when selecting | Overrides HandlerBase::buildExposedForm | |
FilterPluginBase::buildExposeForm | public | function | Options form subform for exposed filter options. | Overrides HandlerBase::buildExposeForm | 4 |
FilterPluginBase::buildGroupForm | public | function | Displays the Build Group form. | ||
FilterPluginBase::buildGroupOptions | protected | function | Provide default options for exposed filters. | ||
FilterPluginBase::buildGroupSubmit | protected | function | Save new group items, re-enumerates and remove groups marked to delete. | ||
FilterPluginBase::buildGroupValidate | protected | function | Validate the build group options form. | ||
FilterPluginBase::buildOptionsForm | public | function | Provide the basic form which calls through to subforms. If overridden, it is best to call through to the parent, or to at least make sure all of the functions in this form are called. |
Overrides HandlerBase::buildOptionsForm | 2 |
FilterPluginBase::canBuildGroup | protected | function | Determine if a filter can be converted into a group. Only exposed filters with operators available can be converted into groups. |
||
FilterPluginBase::canExpose | public | function | Determine if a filter can be exposed. | Overrides HandlerBase::canExpose | 5 |
FilterPluginBase::canGroup | public | function | Can this filter be used in OR groups? | 1 | |
FilterPluginBase::convertExposedInput | public | function | Transform the input from a grouped filter into a standard filter. | ||
FilterPluginBase::defaultExposeOptions | public | function | Provide default options for exposed filters. | Overrides HandlerBase::defaultExposeOptions | 4 |
FilterPluginBase::exposedInfo | public | function | Tell the renderer about our exposed form. This only needs to be overridden for particularly complex forms. And maybe not even then. |
Overrides HandlerBase::exposedInfo | |
FilterPluginBase::exposedTranslate | protected | function | Make some translations to a form item to make it more suitable to exposing. |
||
FilterPluginBase::getCacheContexts | public | function | The cache contexts associated with this object. | Overrides CacheableDependencyInterface::getCacheContexts | 7 |
FilterPluginBase::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | Overrides CacheableDependencyInterface::getCacheMaxAge | |
FilterPluginBase::getCacheTags | public | function | The cache tags associated with this object. | Overrides CacheableDependencyInterface::getCacheTags | 1 |
FilterPluginBase::groupForm | public | function | Build a form containing a group of operator | values to apply as a single filter. |
||
FilterPluginBase::groupMultipleExposedInput | public | function | Returns the options available for a grouped filter that users checkboxes as widget, and therefore has to be applied several times, one per item selected. |
||
FilterPluginBase::hasValidGroupedValue | protected | function | Determines if the given grouped filter entry has a valid value. | 1 | |
FilterPluginBase::isAGroup | public | function | Returns TRUE if the exposed filter works like a grouped filter. | Overrides HandlerBase::isAGroup | |
FilterPluginBase::multipleExposedInput | public | function | Returns TRUE if users can select multiple groups items of a grouped exposed filter. |
Overrides HandlerBase::multipleExposedInput | |
FilterPluginBase::operatorOptions | public | function | Provide a list of options for the default operator form. Should be overridden by classes that don't override operatorForm |
5 | |
FilterPluginBase::operatorSubmit | 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. |
||
FilterPluginBase::operatorValidate | protected | function | Validate the operator form. | ||
FilterPluginBase::prepareFilterSelectOptions | protected | function | Sanitizes the HTML select element's options. | ||
FilterPluginBase::showBuildGroupButton | protected | function | Shortcut to display the build_group/hide button. | ||
FilterPluginBase::showBuildGroupForm | public | function | Shortcut to display the exposed options form. | ||
FilterPluginBase::showExposeButton | public | function | Shortcut to display the expose/hide button. | Overrides HandlerBase::showExposeButton | |
FilterPluginBase::showOperatorForm | public | function | Shortcut to display the operator form. | ||
FilterPluginBase::showValueForm | protected | function | Shortcut to display the value form. | ||
FilterPluginBase::storeExposedInput | public | function | If set to remember exposed input in the session, store it there. | Overrides HandlerBase::storeExposedInput | |
FilterPluginBase::storeGroupInput | public | function | If set to remember exposed input in the session, store it there. This function is similar to storeExposedInput but modified to work properly when the filter is a group. |
||
FilterPluginBase::submitOptionsForm | public | function | Simple submit handler | Overrides PluginBase::submitOptionsForm | |
FilterPluginBase::trustedCallbacks | public static | function | Lists the trusted callbacks provided by the implementing class. | Overrides PluginBase::trustedCallbacks | |
FilterPluginBase::validate | public | function | Validate that the plugin is correct and can be saved. | Overrides HandlerBase::validate | 2 |
FilterPluginBase::validateExposeForm | public | function | Validate the options form. | Overrides HandlerBase::validateExposeForm | |
FilterPluginBase::validateIdentifier | protected | function | Validates a filter identifier. | ||
FilterPluginBase::validateOptionsForm | public | function | Simple validate handler | Overrides PluginBase::validateOptionsForm | 1 |
FilterPluginBase::valueSubmit | protected | 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 | |
FilterPluginBase::valueValidate | protected | function | Validate the options form. | 3 | |
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::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::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::buildExtraOptionsForm | public | function | Provide a form for setting options. | 1 | |
HandlerBase::buildGroupByForm | public | function | Provide a form for aggregation settings. | 1 | |
HandlerBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides PluginBase::calculateDependencies | 10 |
HandlerBase::caseTransform | protected | function | Transform a string by a certain method. | ||
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::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::isExposed | public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. |
||
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::showExposeForm | public | function | Shortcut to display the exposed options form. | Overrides ViewsHandlerInterface::showExposeForm | |
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::validateExtraOptionsForm | public | function | Validate the options form. | ||
HandlerBase::__construct | public | function | Constructs a Handler object. | Overrides PluginBase::__construct | 44 |
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::$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 | 62 |
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::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::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. | |||
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::$alwaysMultiple | protected | property | This filter is always considered multiple-valued. | Overrides FilterPluginBase::$alwaysMultiple | |
Search::$parsed | protected | property | TRUE if the search query has been parsed. | ||
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::defineOptions | protected | function | Information about options for all kinds of purposes will be held here. | Overrides FilterPluginBase::defineOptions | |
Search::init | public | function | Overrides \Drupal\views\Plugin\views\HandlerBase::init(). | Overrides FilterPluginBase::init | |
Search::operatorForm | protected | function | Options form subform for setting the operator. | Overrides FilterPluginBase::operatorForm | |
Search::query | public | function | Add this filter to the query. | Overrides FilterPluginBase::query | |
Search::queryParseSearchExpression | protected | function | Sets up and parses the search query. | ||
Search::validateExposed | public | function | Validate the exposed handler form | Overrides HandlerBase::validateExposed | |
Search::valueForm | protected | function | Options form subform for setting options. | Overrides FilterPluginBase::valueForm | |
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. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.