CountLimitProcessor.php in Facets 8

Namespace

Drupal\facets\Plugin\facets\processor

File

src/Plugin/facets/processor/CountLimitProcessor.php

<?php

namespace Drupal\facets\Plugin\facets\processor;

use Drupal\Core\Form\FormStateInterface;
use Drupal\facets\FacetInterface;
use Drupal\facets\Processor\BuildProcessorInterface;
use Drupal\facets\Processor\ProcessorPluginBase;

/**
 * Provides a count limit processor.
 *
 * @FacetsProcessor(
 *   id = "count_limit",
 *   label = @Translation("Count limit"),
 *   description = @Translation("Show or hide depending on the number of results."),
 *   stages = {
 *     "build" = 50
 *   }
 * )
 */
class CountLimitProcessor extends ProcessorPluginBase implements BuildProcessorInterface {

  /**
   * {@inheritdoc}
   */
  public function build(FacetInterface $facet, array $results) {
    $config = $this
      ->getConfiguration();
    $min_count = $config['minimum_items'];
    $max_count = $config['maximum_items'];

    /** @var \Drupal\facets\Result\Result $result */
    foreach ($results as $id => $result) {
      if ($min_count && $result
        ->getCount() < $min_count || $max_count && $result
        ->getCount() > $max_count) {
        unset($results[$id]);
      }
    }
    return $results;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state, FacetInterface $facet) {
    $config = $this
      ->getConfiguration();
    $build['minimum_items'] = [
      '#title' => $this
        ->t('Minimum items'),
      '#type' => 'number',
      '#min' => 1,
      '#default_value' => $config['minimum_items'],
      '#description' => $this
        ->t('Hide block if the facet contains less than this number of results.'),
    ];
    $max_default_value = $config['maximum_items'];
    $build['maximum_items'] = [
      '#title' => $this
        ->t('Maximum items'),
      '#type' => 'number',
      '#min' => 1,
      '#default_value' => $max_default_value ? $max_default_value : '',
      '#description' => $this
        ->t('Hide block if the facet contains more than this number of results.'),
    ];
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array $form, FormStateInterface $form_state, FacetInterface $facet) {
    $values = $form_state
      ->getValues();
    if (!empty($values['maximum_items']) && !empty($values['minimum_items']) && $values['maximum_items'] <= $values['minimum_items']) {
      $form_state
        ->setErrorByName('maximum_items', t('If both minimum and maximum item count are specified, the maximum item count should be higher than the minimum item count.'));
    }
    return parent::validateConfigurationForm($form, $form_state, $facet);
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'minimum_items' => 1,
      'maximum_items' => 0,
    ];
  }

}

Classes

Name	Description
CountLimitProcessor	Provides a count limit processor.