class SearchApiBackend in Search API 8

Defines a Search API backend annotation object.

Hierarchy

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

See also

\Drupal\search_api\Backend\BackendPluginManager

\Drupal\search_api\Backend\BackendInterface

\Drupal\search_api\Backend\BackendPluginBase

Plugin API

1 file declares its use of SearchApiBackend

BackendPluginManager.php in src/Backend/BackendPluginManager.php

3 classes are annotated with SearchApiBackend

Database in modules/search_api_db/src/Plugin/search_api/backend/Database.php

Indexes and searches items using the database.

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

Provides a test backend that should be hidden from the UI.

TestBackend in tests/search_api_test/src/Plugin/search_api/backend/TestBackend.php

Provides a dummy backend for testing purposes.

File

src/Annotation/SearchApiBackend.php, line 17

Namespace

Drupal\search_api\Annotation

class SearchApiBackend extends Plugin {

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

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

  /**
   * The backend description.
   *
   * @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
SearchApiBackend::$description	public	property	The backend description.
SearchApiBackend::$id	public	property	The backend plugin ID.
SearchApiBackend::$label	public	property	The human-readable name of the backend plugin.