interface BuildProcessorInterface in Facets 8

Processor runs before the renderable array is created.

Hierarchy

• interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\DependentPluginInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\facets_summary\Processor\ProcessorInterface
    • interface \Drupal\facets_summary\Processor\BuildProcessorInterface

6 files declare their use of BuildProcessorInterface

DefaultFacetsSummaryManager.php in modules/facets_summary/src/FacetsSummaryManager/DefaultFacetsSummaryManager.php

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

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

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

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

... See full list

File

modules/facets_summary/src/Processor/BuildProcessorInterface.php, line 10

Namespace

Drupal\facets_summary\Processor

interface BuildProcessorInterface extends ProcessorInterface {

  /**
   * Alter the items in the summary before creating the renderable array.
   *
   * @param \Drupal\facets_summary\FacetsSummaryInterface $facet
   *   The facet being changed.
   * @param array $build
   *   The render array.
   * @param \Drupal\facets\FacetInterface[] $facets
   *   The facets that are available.
   *
   * @return array
   *   The render array.
   */
  public function build(FacetsSummaryInterface $facet, array $build, array $facets);

}

Members

Name	Modifiers	Type	Description	Overrides
BuildProcessorInterface::build	public	function	Alter the items in the summary before creating the renderable array.
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	11
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	12
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	12
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	19
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2
ProcessorInterface::buildConfigurationForm	public	function	Adds a configuration form for this processor.
ProcessorInterface::getDefaultWeight	public	function	Returns the default weight for a specific processing stage.
ProcessorInterface::getDescription	public	function	Retrieves the processor description.
ProcessorInterface::isHidden	public	function	Determines whether this processor should be hidden from the user.
ProcessorInterface::isLocked	public	function	Determines whether this processor should always be enabled.
ProcessorInterface::STAGE_BUILD		constant	Processing stage: build.
ProcessorInterface::submitConfigurationForm	public	function	Submits a configuration form for this processor.	1
ProcessorInterface::supportsStage	public	function	Checks whether this processor implements a particular stage.
ProcessorInterface::validateConfigurationForm	public	function	Validates a configuration form for this processor.