class FacetsUrlProcessor in Facets 8

Defines a Facets URL Processor annotation.

Hierarchy

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

See also

\Drupal\facets\Processor\ProcessorPluginManager

Plugin API

1 file declares its use of FacetsUrlProcessor

UrlProcessorPluginManager.php in src/UrlProcessor/UrlProcessorPluginManager.php

2 classes are annotated with FacetsUrlProcessor

DummyQuery in tests/facets_query_processor/src/Plugin/facets/url_processor/DummyQuery.php

Query string URL processor.

QueryString in src/Plugin/facets/url_processor/QueryString.php

Query string URL processor.

File

src/Annotation/FacetsUrlProcessor.php, line 17

Namespace

Drupal\facets\Annotation

class FacetsUrlProcessor extends Plugin {

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

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

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

}

Members

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