class SummaryProcessor in Facets 8

Defines a facets summary display processor.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\facets_summary\Annotation\SummaryProcessor

See also

\Drupal\facets\Processor\ProcessorPluginManager

Plugin API

1 file declares its use of SummaryProcessor

ProcessorPluginManager.php in modules/facets_summary/src/Processor/ProcessorPluginManager.php

5 classes are annotated with SummaryProcessor

HideWhenNotRenderedProcessor in modules/facets_summary/src/Plugin/facets_summary/processor/HideWhenNotRenderedProcessor.php

Provides a processor that hides the summary when the source was not rendered.

ResetFacetsProcessor in modules/facets_summary/src/Plugin/facets_summary/processor/ResetFacetsProcessor.php

Provides a processor that adds a link to reset facet filters.

ShowCountProcessor in modules/facets_summary/src/Plugin/facets_summary/processor/ShowCountProcessor.php

Provides a processor that shows a summary of how many results were found.

ShowSummaryProcessor in modules/facets_summary/src/Plugin/facets_summary/processor/ShowSummaryProcessor.php

Provides a processor that shows a summary of all selected facets.

ShowTextWhenEmptyProcessor in modules/facets_summary/src/Plugin/facets_summary/processor/ShowTextWhenEmptyProcessor.php

Provides a processor that shows a text when there are no results.

File

modules/facets_summary/src/Annotation/SummaryProcessor.php, line 17

Namespace

Drupal\facets_summary\Annotation

class SummaryProcessor extends Plugin {

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

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

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

  /**
   * 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_summary\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
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
SummaryProcessor::$default_enabled	public	property
SummaryProcessor::$description	public	property	The plugin description.
SummaryProcessor::$id	public	property	The plugin id.
SummaryProcessor::$label	public	property	The human-readable name of the plugin.
SummaryProcessor::$stages	public	property	The stages this processor will run in, along with their default weights.