You are here

Home » API reference » Facets 8 » DependentFacetProcessor.php

class DependentFacetProcessor in Facets 8

Provides a processor that makes a facet depend on the state of another facet.

Plugin annotation


@FacetsProcessor(
  id = "dependent_processor",
  label = @Translation("Dependent facet"),
  description = @Translation("Display this facet depending on the state of another facet."),
  stages = {
    "build" = 5
  }
)

Hierarchy

Expanded class hierarchy of DependentFacetProcessor

1 file declares its use of DependentFacetProcessor
DependentFacetProcessorTest.php in tests/src/Unit/Plugin/processor/DependentFacetProcessorTest.php

File

src/Plugin/facets/processor/DependentFacetProcessor.php, line 26

Namespace

Drupal\facets\Plugin\facets\processor
View source 
class DependentFacetProcessor extends ProcessorPluginBase implements BuildProcessorInterface, ContainerFactoryPluginInterface {

  /**
   * The language manager.
   *
   * @var \Drupal\facets\FacetManager\DefaultFacetManager
   */
  protected $facetsManager;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $facetStorage;

  /**
   * Constructs a new object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\facets\FacetManager\DefaultFacetManager $facets_manager
   *   The language manager.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, DefaultFacetManager $facets_manager, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->facetsManager = $facets_manager;
    $this->facetStorage = $entity_type_manager
      ->getStorage('facets_facet');
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('facets.manager'), $container
      ->get('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state, FacetInterface $current_facet) {
    $build = [];
    $config = $this
      ->getConfiguration();

    // Loop over all defined blocks and filter them by provider, this builds an
    // array of blocks that are provided by the facets module.

    /** @var \Drupal\facets\Entity\Facet[] $facets */
    $facets = $this->facetStorage
      ->loadMultiple();
    foreach ($facets as $facet) {
      if ($facet
        ->getFacetSourceId() !== $current_facet
        ->getFacetSourceId()) {
        continue;
      }
      if ($facet
        ->id() === $current_facet
        ->id()) {
        continue;
      }
      $build[$facet
        ->id()]['label'] = [
        '#title' => $facet
          ->getName(),
        '#type' => 'label',
      ];
      $build[$facet
        ->id()]['enable'] = [
        '#title' => $this
          ->t('Enable condition'),
        '#type' => 'checkbox',
        '#default_value' => !empty($config[$facet
          ->id()]['enable']),
      ];
      $build[$facet
        ->id()]['condition'] = [
        '#title' => $this
          ->t('Condition mode'),
        '#type' => 'radios',
        '#options' => [
          'presence' => $this
            ->t('Check whether the facet is present.'),
          'not_empty' => $this
            ->t('Check whether the facet is selected / not empty.'),
          'values' => $this
            ->t('Check whether the facet is set to specific values.'),
        ],
        '#default_value' => empty($config[$facet
          ->id()]['condition']) ? NULL : $config[$facet
          ->id()]['condition'],
        '#states' => [
          'visible' => [
            ':input[name="facet_settings[' . $this
              ->getPluginId() . '][settings][' . $facet
              ->id() . '][enable]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ];
      $build[$facet
        ->id()]['values'] = [
        '#title' => $this
          ->t('Values'),
        '#type' => 'textfield',
        '#default_value' => empty($config[$facet
          ->id()]['values']) ? '' : $config[$facet
          ->id()]['values'],
        '#states' => [
          'visible' => [
            ':input[name="facet_settings[' . $this
              ->getPluginId() . '][settings][' . $facet
              ->id() . '][enable]"]' => [
              'checked' => TRUE,
            ],
            ':input[name="facet_settings[' . $this
              ->getPluginId() . '][settings][' . $facet
              ->id() . '][condition]"]' => [
              'value' => 'values',
            ],
          ],
        ],
      ];
      $build[$facet
        ->id()]['negate'] = [
        '#title' => $this
          ->t('Negate condition'),
        '#type' => 'checkbox',
        '#default_value' => !empty($config[$facet
          ->id()]['negate']),
        '#states' => [
          'visible' => [
            ':input[name="facet_settings[' . $this
              ->getPluginId() . '][settings][' . $facet
              ->id() . '][enable]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ];
    }
    return parent::buildConfigurationForm($form, $form_state, $current_facet) + $build;
  }

  /**
   * {@inheritdoc}
   */
  public function build(FacetInterface $facet, array $results) {
    $conditions = $this
      ->getConfiguration();
    foreach ($conditions as $facet_id => $condition) {
      if (empty($condition['enable'])) {
        continue;
      }
      $enabled_conditions[$facet_id] = $condition;
    }

    // Return as early as possible when there are no settings for allowed
    // facets.
    if (empty($enabled_conditions)) {
      return $results;
    }
    $return = TRUE;
    foreach ($enabled_conditions as $facet_id => $condition_settings) {

      /** @var \Drupal\facets\Entity\Facet $current_facet */
      $current_facet = $this->facetStorage
        ->load($facet_id);
      $current_facet = $this->facetsManager
        ->returnProcessedFacet($current_facet);
      if ($condition_settings['condition'] == 'not_empty') {
        $return = !empty($current_facet
          ->getActiveItems());
      }
      if ($condition_settings['condition'] == 'values') {
        $return = FALSE;
        $values = explode(',', $condition_settings['values']);
        foreach ($current_facet
          ->getResults() as $result) {
          $isActive = $result
            ->isActive();
          $raw_value_in_expected = in_array($result
            ->getRawValue(), $values);
          $display_value_in_expected = in_array($result
            ->getDisplayValue(), $values);
          if ($isActive && ($raw_value_in_expected || $display_value_in_expected)) {
            $return = TRUE;
          }
        }
      }
      if (!empty($condition_settings['negate'])) {
        $return = !$return;
      }
    }
    return $return ? $results : [];
  }

}

Members

Namesort descending 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
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
DependentFacetProcessor::$facetsManager protected property The language manager.
DependentFacetProcessor::$facetStorage protected property The entity type manager.
DependentFacetProcessor::build public function Runs before the renderable array is created. Overrides BuildProcessorInterface::build
DependentFacetProcessor::buildConfigurationForm public function Adds a configuration form for this processor. Overrides ProcessorPluginBase::buildConfigurationForm
DependentFacetProcessor::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
DependentFacetProcessor::__construct public function Constructs a new object. Overrides PluginBase::__construct
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.
ProcessorInterface::STAGE_BUILD constant Processing stage: build.
ProcessorInterface::STAGE_POST_QUERY constant Processing stage: post_query.
ProcessorInterface::STAGE_PRE_QUERY constant Processing stage: pre_query.
ProcessorInterface::STAGE_SORT constant Processing stage: sort.
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 8
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::getQueryType public function Picks the preferred query type for this widget. Overrides ProcessorInterface::getQueryType 4
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
ProcessorPluginBase::supportsFacet public function Checks if the facet is supported by this widget. Overrides ProcessorInterface::supportsFacet 6
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 2
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.