class FacetsFacetSource in Facets 8

Defines a Facets facet source annotation.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\facets\Annotation\FacetsFacetSource

See also

\Drupal\facets\FacetSource\FacetSourcePluginManager

\Drupal\facets\FacetSource\FacetSourcePluginInterface

\Drupal\facets\FacetSource\FacetSourcePluginBase

Plugin API

1 file declares its use of FacetsFacetSource

FacetSourcePluginManager.php in src/FacetSource/FacetSourcePluginManager.php

1 class is annotated with FacetsFacetSource

SearchApiDisplay in src/Plugin/facets/facet_source/SearchApiDisplay.php

Provides a facet source based on a Search API display.

File

src/Annotation/FacetsFacetSource.php, line 17

Namespace

Drupal\facets\Annotation

class FacetsFacetSource extends Plugin {

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

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

  /**
   * The facet source description.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description;

  /**
   * The id of the search api display, if one is used.
   *
   * @var string
   */

  // @codingStandardsIgnoreStart
  public $display_id;

}

Members

Name	Modifiers	Type	Description	Overrides
FacetsFacetSource::$description	public	property	The facet source description.
FacetsFacetSource::$display_id	public	property
FacetsFacetSource::$id	public	property	The facet source plugin ID.
FacetsFacetSource::$label	public	property	The human-readable name of the facet source plugin.
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