You are here

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

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_mode
View source
class Direct extends ParseModePluginBase {

  /**
   * {@inheritdoc}
   */
  public function parseInput($keys) {
    return $keys;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
Direct::parseInput public function Parses search keys input by the user. Overrides ParseModeInterface::parseInput
HideablePluginBase::isHidden public function Determines whether this plugin should be hidden in the UI. Overrides HideablePluginInterface::isHidden 1
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
ParseModePluginBase::$conjunction protected property The default conjunction to use when parsing keywords.
ParseModePluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ParseModePluginBase::getConjunction public function Retrieves the default conjunction. Overrides ParseModeInterface::getConjunction
ParseModePluginBase::getDescription public function Returns the description of the parse mode. Overrides ParseModeInterface::getDescription
ParseModePluginBase::label public function Returns the label of the parse mode. Overrides ParseModeInterface::label
ParseModePluginBase::setConjunction public function Sets the default conjunction. Overrides ParseModeInterface::setConjunction
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
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::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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.