class SearchApiDisplay in Search API 8

Defines a Search API display annotation object.

Hierarchy

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

See also

\Drupal\search_api\Display\DisplayPluginManager

\Drupal\search_api\Display\DisplayInterface

\Drupal\search_api\Display\DisplayPluginBase

Plugin API

6 classes are annotated with SearchApiDisplay

TestDisplay in tests/search_api_test/src/Plugin/search_api/display/TestDisplay.php

Provides a test display.

ViewsBlock in src/Plugin/search_api/display/ViewsBlock.php

Represents a Views block display.

ViewsEmbed in src/Plugin/search_api/display/ViewsEmbed.php

Represents a Views embed display.

ViewsFeed in src/Plugin/search_api/display/ViewsFeed.php

Represents a Views feed display.

ViewsPage in src/Plugin/search_api/display/ViewsPage.php

Represents a Views page display.

... See full list

File

src/Annotation/SearchApiDisplay.php, line 17

Namespace

Drupal\search_api\Annotation

class SearchApiDisplay extends Plugin {

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

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

  /**
   * The human-readable description for the display plugin.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $description;

  /**
   * The ID of the display's index.
   *
   * @var string
   */
  public $index;

  /**
   * The path to the search display, if any.
   *
   * @var string|null
   */
  public $path;

}

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
SearchApiDisplay::$description	public	property	The human-readable description for the display plugin.
SearchApiDisplay::$id	public	property	The display plugin ID.
SearchApiDisplay::$index	public	property	The ID of the display's index.
SearchApiDisplay::$label	public	property	The human-readable name of the display plugin.
SearchApiDisplay::$path	public	property	The path to the search display, if any.