abstract class ParseModePluginBase in Search API 8

Defines a base class from which other parse mode classes may extend.

Plugins extending this class need to define a plugin definition array through annotation. These definition arrays may be altered through hook_search_api_parse_mode_info_alter(). The definition includes the following keys:

• id: The unique, system-wide identifier of the parse mode.
• label: The human-readable name of the parse mode class, translated.
• description: A human-readable description for the parse mode, translated.

A complete plugin definition should be written as in this example:

@SearchApiParseMode(
  id = "my_parse_mode",
  label = @Translation("My parse mode"),
  description = @Translation("Some information about my parse mode"),
)

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

See also

\Drupal\search_api\Annotation\SearchApiParseMode

\Drupal\search_api\ParseMode\ParseModePluginManager

\Drupal\search_api\ParseMode\ParseModeInterface

Plugin API

4 files declare their use of ParseModePluginBase

Direct.php in src/Plugin/search_api/parse_mode/Direct.php

NoUi.php in tests/search_api_test_no_ui/src/Plugin/search_api/parse_mode/NoUi.php

Phrase.php in src/Plugin/search_api/parse_mode/Phrase.php

Terms.php in src/Plugin/search_api/parse_mode/Terms.php

File

src/ParseMode/ParseModePluginBase.php, line 34

Namespace

Drupal\search_api\ParseMode

abstract class ParseModePluginBase extends HideablePluginBase implements ParseModeInterface {

  /**
   * The default conjunction to use when parsing keywords.
   *
   * @var string
   */
  protected $conjunction = 'AND';

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition);
  }

  /**
   * {@inheritdoc}
   */
  public function label() {
    $plugin_definition = $this
      ->getPluginDefinition();
    return $plugin_definition['label'];
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    $plugin_definition = $this
      ->getPluginDefinition();
    return $plugin_definition['description'];
  }

  /**
   * {@inheritdoc}
   */
  public function getConjunction() {
    return $this->conjunction;
  }

  /**
   * {@inheritdoc}
   */
  public function setConjunction($conjunction) {
    $this->conjunction = $conjunction;
    return $this;
  }

}

Members

Name	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
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.
ParseModeInterface::parseInput	public	function	Parses search keys input by the user.	4
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.