class Direct in Search API 8
Represents a parse mode that just passes the user input on as-is.
Plugin annotation
@SearchApiParseMode(
id = "direct",
label = @Translation("Direct query"),
description = @Translation("Don't parse the query, just hand it to the search server unaltered. Might fail if the query contains syntax errors in regard to the specific server's query syntax."),
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\search_api\Plugin\HideablePluginBase implements HideablePluginInterface
- class \Drupal\search_api\ParseMode\ParseModePluginBase implements ParseModeInterface
- class \Drupal\search_api\Plugin\search_api\parse_mode\Direct
- class \Drupal\search_api\ParseMode\ParseModePluginBase implements ParseModeInterface
- class \Drupal\search_api\Plugin\HideablePluginBase implements HideablePluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of Direct
1 file declares its use of Direct
- TokenizerTest.php in tests/
src/ Unit/ Processor/ TokenizerTest.php
File
- src/
Plugin/ search_api/ parse_mode/ Direct.php, line 16
Namespace
Drupal\search_api\Plugin\search_api\parse_modeView source
class Direct extends ParseModePluginBase {
/**
* {@inheritdoc}
*/
public function parseInput($keys) {
return $keys;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
Direct:: |
public | function |
Parses search keys input by the user. Overrides ParseModeInterface:: |
|
HideablePluginBase:: |
public | function |
Determines whether this plugin should be hidden in the UI. Overrides HideablePluginInterface:: |
1 |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
ParseModePluginBase:: |
protected | property | The default conjunction to use when parsing keywords. | |
ParseModePluginBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
ParseModePluginBase:: |
public | function |
Retrieves the default conjunction. Overrides ParseModeInterface:: |
|
ParseModePluginBase:: |
public | function |
Returns the description of the parse mode. Overrides ParseModeInterface:: |
|
ParseModePluginBase:: |
public | function |
Returns the label of the parse mode. Overrides ParseModeInterface:: |
|
ParseModePluginBase:: |
public | function |
Sets the default conjunction. Overrides ParseModeInterface:: |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 92 |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |