class FacetsWidget in Facets 8

Defines a Facets Widget annotation.

Hierarchy

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

See also

\Drupal\facets\Widget\WidgetPluginManager

Plugin API

1 file declares its use of FacetsWidget

WidgetPluginManager.php in src/Widget/WidgetPluginManager.php

9 classes are annotated with FacetsWidget

ArrayWidget in src/Plugin/facets/widget/ArrayWidget.php

A simple widget class that returns a simple array of the facet results.

CheckboxWidget in src/Plugin/facets/widget/CheckboxWidget.php

The checkbox / radios widget.

CustomWidget in tests/facets_custom_widget/src/Plugin/facets/widget/CustomWidget.php

A simple widget class that returns a simple array of the facet results.

DropdownWidget in src/Plugin/facets/widget/DropdownWidget.php

The dropdown widget.

LinksWidget in src/Plugin/facets/widget/LinksWidget.php

The links widget.

... See full list

File

src/Annotation/FacetsWidget.php, line 17

Namespace

Drupal\facets\Annotation

class FacetsWidget extends Plugin {

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

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

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

  /**
   * The possible query types used by this widget.
   *
   * @var array
   */
  public $queryType = [];

  /**
   * Class used to retrieve derivative definitions of the facet_manager.
   *
   * @var string
   */
  public $derivative = '';

}

Members

Name	Modifiers	Type	Description	Overrides
FacetsWidget::$derivative	public	property	Class used to retrieve derivative definitions of the facet_manager.
FacetsWidget::$description	public	property	The widget description.
FacetsWidget::$id	public	property	The widget plugin id.
FacetsWidget::$label	public	property	The human-readable name of the widget plugin.
FacetsWidget::$queryType	public	property	The possible query types used by this widget.
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