class SearchApiParseMode in Search API 8

Defines a Search API parse mode annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\search_api\Annotation\SearchApiParseMode

See also

\Drupal\search_api\ParseMode\ParseModePluginManager

\Drupal\search_api\ParseMode\ParseModeInterface

\Drupal\search_api\ParseMode\ParseModePluginBase

Plugin API

4 classes are annotated with SearchApiParseMode

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

Represents a parse mode that just passes the user input on as-is.

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

Provides a parse mode that should be hidden from the UI.

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

Represents a parse mode that interprets the input as a single phrase.

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

Represents a parse mode that parses the input into multiple words.

File

src/Annotation/SearchApiParseMode.php, line 17

Namespace

Drupal\search_api\Annotation

class SearchApiParseMode extends Plugin {

  /**
   * The parse mode plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the parse mode.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $label;

  /**
   * The description of the parse mode.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $description;

}

Members

Name	Modifiers	Type	Description	Overrides
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2
SearchApiParseMode::$description	public	property	The description of the parse mode.
SearchApiParseMode::$id	public	property	The parse mode plugin ID.
SearchApiParseMode::$label	public	property	The human-readable name of the parse mode.