GranularItemProcessor.php in Facets 8

Namespace

Drupal\facets\Plugin\facets\processor

File

src/Plugin/facets/processor/GranularItemProcessor.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 processor for granularity.
 *
 * @FacetsProcessor(
 *   id = "granularity_item",
 *   label = @Translation("Granularity item processor"),
 *   description = @Translation("List of numbers grouped in steps."),
 *   stages = {
 *     "build" = 35
 *   }
 * )
 */
class GranularItemProcessor extends ProcessorPluginBase implements BuildProcessorInterface {

  /**
   * {@inheritdoc}
   */
  public function build(FacetInterface $facet, array $results) {

    /** @var \Drupal\facets\Result\ResultInterface $result */
    foreach ($results as $result) {
      $value = $result
        ->getRawValue();
      if (is_numeric($value)) {
        $result
          ->setDisplayValue((int) $value . ' - ' . ((int) $value + $this
          ->getConfiguration()['granularity']));
      }
    }
    return $results;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'granularity' => 1,
      'min_value' => '',
      'max_value' => '',
      'include_lower' => TRUE,
      'include_upper' => FALSE,
      'include_edges' => TRUE,
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state, FacetInterface $facet) {
    $configuration = $this
      ->getConfiguration();
    $build['granularity'] = [
      '#type' => 'number',
      '#attributes' => [
        'min' => 1,
        'step' => 1,
      ],
      '#title' => $this
        ->t('Granularity'),
      '#default_value' => $configuration['granularity'],
      '#description' => $this
        ->t('The numeric size of the steps to group the result facets in.'),
    ];
    $build['min_value'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Minimum value'),
      '#default_value' => $configuration['min_value'],
      '#description' => $this
        ->t('If the minimum value is left empty it will be calculated by the search result'),
      '#size' => 10,
    ];
    $build['max_value'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Maximum value'),
      '#default_value' => $configuration['max_value'],
      '#description' => $this
        ->t('If the maximum value is left empty it will be calculated by the search result'),
      '#size' => 10,
    ];
    $build['include_lower'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Include lower bounds'),
      '#default_value' => $configuration['include_lower'],
    ];
    $build['include_upper'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Include upper bounds'),
      '#default_value' => $configuration['include_upper'],
    ];
    $build['include_edges'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Include first lower and last upper bound'),
      '#default_value' => $configuration['include_edges'],
    ];
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function getQueryType() {
    return 'numeric';
  }

}

Classes

Name	Description
GranularItemProcessor	Provides a processor for granularity.