class FacetsHierarchy in Facets 8

Defines a Facets Hierarchy annotation.

Hierarchy

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

See also

\Drupal\facets\Hierarchy\HierarchyPluginManager

Plugin API

1 file declares its use of FacetsHierarchy

HierarchyPluginManager.php in src/Hierarchy/HierarchyPluginManager.php

1 class is annotated with FacetsHierarchy

Taxonomy in src/Plugin/facets/hierarchy/Taxonomy.php

Taxonomy hierarchy.

File

src/Annotation/FacetsHierarchy.php, line 17

Namespace

Drupal\facets\Annotation

class FacetsHierarchy extends Plugin {

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

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

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

}

Members

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