class SearchApiTracker in Search API 8

Defines a Search API tracker annotation object.

Hierarchy

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

See also

\Drupal\search_api\Tracker\TrackerPluginManager

\Drupal\search_api\Tracker\TrackerInterface

\Drupal\search_api\Tracker\TrackerPluginBase

Plugin API

4 classes are annotated with SearchApiTracker

Basic in src/Plugin/search_api/tracker/Basic.php

Provides a tracker implementation which uses a FIFO-like processing order.

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

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

TestTracker in tests/search_api_test/src/Plugin/search_api/tracker/TestTracker.php

Provides a tracker implementation which uses a FIFO-like processing order.

TestTrackerStringLabel in tests/search_api_test/src/Plugin/search_api/tracker/TestTrackerStringLabel.php

Provides a tracker implementation which uses a FIFO-like processing order.

File

src/Annotation/SearchApiTracker.php, line 17

Namespace

Drupal\search_api\Annotation

class SearchApiTracker extends Plugin {

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

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

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