You are here

Home » API reference » Facets 8 » GranularItemProcessor.php

class GranularItemProcessor in Facets 8

Provides a processor for granularity.

Plugin annotation


@FacetsProcessor(
  id = "granularity_item",
  label = @Translation("Granularity item processor"),
  description = @Translation("List of numbers grouped in steps."),
  stages = {
    "build" = 35
  }
)

Hierarchy

Expanded class hierarchy of GranularItemProcessor

1 file declares its use of GranularItemProcessor
SearchApiGranularTest.php in tests/src/Unit/Plugin/query_type/SearchApiGranularTest.php

File

src/Plugin/facets/processor/GranularItemProcessor.php, line 22

Namespace

Drupal\facets\Plugin\facets\processor
View source 
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';
  }

}

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.
GranularItemProcessor::build public function Runs before the renderable array is created. Overrides BuildProcessorInterface::build
GranularItemProcessor::buildConfigurationForm public function Adds a configuration form for this processor. Overrides ProcessorPluginBase::buildConfigurationForm
GranularItemProcessor::defaultConfiguration public function Gets default configuration for this plugin. Overrides ProcessorPluginBase::defaultConfiguration
GranularItemProcessor::getQueryType public function Picks the preferred query type for this widget. Overrides ProcessorPluginBase::getQueryType
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.
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::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
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.