class FacetsProcessor in Facets 8

Defines a Facets Processor annotation.

Hierarchy

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

See also

\Drupal\facets\Processor\ProcessorPluginManager

Plugin API

1 file declares its use of FacetsProcessor

ProcessorPluginManager.php in src/Processor/ProcessorPluginManager.php

25 classes are annotated with FacetsProcessor

ActiveWidgetOrderProcessor in src/Plugin/facets/processor/ActiveWidgetOrderProcessor.php

A processor that orders the results by active state.

BooleanItemProcessor in src/Plugin/facets/processor/BooleanItemProcessor.php

Provides a processor for boolean labels.

CountLimitProcessor in src/Plugin/facets/processor/CountLimitProcessor.php

Provides a count limit processor.

CountWidgetOrderProcessor in src/Plugin/facets/processor/CountWidgetOrderProcessor.php

A processor that orders the results by amount.

DateItemProcessor in src/Plugin/facets/processor/DateItemProcessor.php

Provides a processor for dates.

... See full list

File

src/Annotation/FacetsProcessor.php, line 17

Namespace

Drupal\facets\Annotation

class FacetsProcessor extends Plugin {

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

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

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

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

  /**
   * The stages this processor will run in, along with their default weights.
   *
   * This is represented as an associative array, mapping one or more of the
   * stage identifiers to the default weight for that stage. For the available
   * stages, see
   * \Drupal\facets\Processor\ProcessorPluginManager::getProcessingStages().
   *
   * @var int[]
   */
  public $stages;

  /**
   * Whether or not this processor is default enabled for new facets.
   *
   * @var bool
   */

  // @codingStandardsIgnoreStart
  public $default_enabled;

}

Members

Name	Modifiers	Type	Description	Overrides
FacetsProcessor::$default_enabled	public	property
FacetsProcessor::$derivative	public	property	Class used to retrieve derivative definitions of the url processor.
FacetsProcessor::$description	public	property	The processor description.
FacetsProcessor::$id	public	property	The processor plugin id.
FacetsProcessor::$label	public	property	The human-readable name of the processor plugin.
FacetsProcessor::$stages	public	property	The stages this processor will run in, along with their default weights.
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