class ShowSummaryProcessor in Facets 8

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

Plugin annotation

@SummaryProcessor(
  id = "show_summary",
  label = @Translation("Show a summary of all selected facets"),
  description = @Translation("When checked, this facet will show an imploded list of all selected facets."),
  stages = {
    "build" = 20
  }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\facets_summary\Processor\ProcessorPluginBase implements ProcessorInterface
      • class \Drupal\facets_summary\Plugin\facets_summary\processor\ShowSummaryProcessor implements BuildProcessorInterface

File

modules/facets_summary/src/Plugin/facets_summary/processor/ShowSummaryProcessor.php, line 21

Namespace

Drupal\facets_summary\Plugin\facets_summary\processor

class ShowSummaryProcessor extends ProcessorPluginBase implements BuildProcessorInterface {

  /**
   * {@inheritdoc}
   */
  public function build(FacetsSummaryInterface $facets_summary, array $build, array $facets) {
    $facets_config = $facets_summary
      ->getFacets();
    if (!isset($build['#items'])) {
      return $build;
    }

    /** @var \Drupal\facets\Entity\Facet $facet */
    foreach ($facets as $facet) {
      if (empty($facet
        ->getActiveItems())) {
        continue;
      }
      $items = $this
        ->getActiveDisplayValues($facet
        ->getResults());
      $facet_summary = [
        '#theme' => 'facets_summary_facet',
        '#label' => $facets_config[$facet
          ->id()]['label'],
        '#separator' => $facets_config[$facet
          ->id()]['separator'],
        '#items' => $items,
        '#facet_id' => $facet
          ->id(),
        '#facet_admin_label' => $facet
          ->getName(),
      ];
      array_unshift($build['#items'], $facet_summary);
    }
    return $build;
  }

  /**
   * Get all active results' display values from hierarchy.
   *
   * @param \Drupal\facets\Result\ResultInterface[] $results
   *   The results to check for active children.
   *
   * @return \Drupal\facets\Result\ResultInterface[]
   *   The active results found.
   */
  protected function getActiveDisplayValues(array $results) {
    $items = [];
    foreach ($results as $result) {
      if ($result
        ->isActive()) {
        $items[] = $result
          ->getDisplayValue();
      }
      if ($result
        ->hasActiveChildren()) {
        $items = array_merge($items, $this
          ->getActiveDisplayValues($result
          ->getChildren()));
      }
    }
    return $items;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
ProcessorInterface::STAGE_BUILD		constant	Processing stage: build.
ProcessorPluginBase::buildConfigurationForm	public	function	Adds a configuration form for this processor. Overrides ProcessorInterface::buildConfigurationForm
ProcessorPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ProcessorPluginBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
ProcessorPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ProcessorPluginBase::getDefaultWeight	public	function	Returns the default weight for a specific processing stage. Overrides ProcessorInterface::getDefaultWeight
ProcessorPluginBase::getDescription	public	function	Retrieves the processor description. Overrides ProcessorInterface::getDescription
ProcessorPluginBase::isHidden	public	function	Determines whether this processor should be hidden from the user. Overrides ProcessorInterface::isHidden
ProcessorPluginBase::isLocked	public	function	Determines whether this processor should always be enabled. Overrides ProcessorInterface::isLocked
ProcessorPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ProcessorPluginBase::submitConfigurationForm	public	function	Submits a configuration form for this processor. Overrides ProcessorInterface::submitConfigurationForm
ProcessorPluginBase::supportsStage	public	function	Checks whether this processor implements a particular stage. Overrides ProcessorInterface::supportsStage
ProcessorPluginBase::validateConfigurationForm	public	function	Validates a configuration form for this processor. Overrides ProcessorInterface::validateConfigurationForm
ShowSummaryProcessor::build	public	function	Alter the items in the summary before creating the renderable array. Overrides BuildProcessorInterface::build
ShowSummaryProcessor::getActiveDisplayValues	protected	function	Get all active results' display values from hierarchy.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.