You are here

Home » API reference » Search API Grouping 8 » Grouping.php

class Grouping in Search API Grouping 8

Processor for grouping up items on behalf of user defined fields.

(see https://issues.apache.org/jira/browse/SOLR-10894 and https://mail-archives.apache.org/mod_mbox/lucene-solr-user/201805.mbox/%...)

Plugin annotation


@SearchApiProcessor(
  id = "grouping",
  label = @Translation("Grouping"),
  description = @Translation("This processor will group the result items based on the configured fields"),
  stages = {
    "add_properties" = 0,
    "postprocess_query" = 0,
    "preprocess_query" = -6,
  },
)

Hierarchy

Expanded class hierarchy of Grouping

4 files declare their use of Grouping
GroupingBuildFormTest.php in tests/src/Unit/GroupingBuildFormTest.php
GroupingSolrTest.php in tests/src/Unit/GroupingSolrTest.php
GroupLimitValidationTest.php in tests/src/Unit/GroupLimitValidationTest.php
SupportedGroupingFieldsTest.php in tests/src/Unit/SupportedGroupingFieldsTest.php

File

src/Plugin/search_api/processor/Grouping.php, line 27

Namespace

Drupal\search_api_grouping\Plugin\search_api\processor
View source 
class Grouping extends FieldsProcessorPluginBase implements PluginFormInterface {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $configuration = parent::defaultConfiguration();
    $configuration += [
      'grouping_fields' => [],
      'group_sort' => [],
      'group_sort_direction' => 'asc',
      'truncate' => FALSE,
      'group_limit' => 1,
    ];
    return $configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $grouping_fields =& $form_state
      ->getValue('grouping_fields');
    $grouping_fields = array_keys(array_filter($grouping_fields));
    $this
      ->setConfiguration($form_state
      ->getValues());
  }

  /**
   * Return the settings form for this processor.
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $supported_fields = $this
      ->getSupportedFields();
    $form['grouping_fields'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Fields to collapse on'),
      '#options' => $supported_fields['field_options'],
      '#attributes' => [
        'class' => [
          'search-api-checkboxes-list',
        ],
      ],
      '#description' => $this
        ->t('Choose the fields upon which to collapse the results into groups. Note that while selecting multiple fields is technicially supported, it may result in unexpected behaviour.'),
      '#default_value' => $this->configuration['grouping_fields'],
    ];
    $form['group_sort'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Group sort'),
      '#options' => $supported_fields['field_sorts'],
      '#description' => $this
        ->t('Choose the field by to sort within each group, the groups themselves will be sorted by the main query sorts.'),
      '#default_value' => $this->configuration['group_sort'],
    ];
    $form['group_sort_direction'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Group sort direction'),
      '#options' => [
        'asc' => $this
          ->t('Ascending'),
        'desc' => $this
          ->t('Descending'),
      ],
      '#default_value' => $this->configuration['group_sort_direction'],
    ];
    $form['truncate'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Truncate results before facets'),
      '#description' => $this
        ->t('If checked, facet counts are based on the most relevant document of each group matching the query, otherwise they are calculated for all documents before grouping.'),
      '#default_value' => $this->configuration['truncate'],
    ];
    $form['group_limit'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Results per group'),
      '#description' => $this
        ->t('The number of results are limited per group. By default, 1 result per group is returned.'),
      '#default_value' => $this->configuration['group_limit'],
      '#element_validate' => [
        'element_validate_integer_positive',
      ],
      '#size' => 3,
    ];
    return $form;
  }

  /**
   * Returns an array of supported fields to choose of.
   *
   * This function respects the server behind the index to provide only valid
   * fields.
   *
   * @return array
   *   An associative array with child arrays for the supported fields for each
   *   feature:
   *   [
   *    'field_options' => [],
   *    'field_sorts' => [],
   *    'field' => [],
   *   ];
   */
  public function getSupportedFields() {
    $fields = $this->index
      ->getFields();
    $supported_fields = [
      'field_options' => [],
      'field_sorts' => [
        '' => $this
          ->t('None'),
        'search_api_relevance' => $this
          ->t('Score/Relevance'),
      ],
      'default_fields' => [],
    ];
    foreach ($fields as $name => $field) {
      if ($field
        ->getType() == 'string' || $field
        ->getType() == 'integer') {
        $conversion_msg = $field
          ->getType() != 'string' ? ' (' . $this
          ->t('Converted to string for indexing') . ')' : NULL;
        $supported_fields['field_options'][$name] = $field
          ->getLabel() . $conversion_msg;
        if (!empty($default_fields[$name]) || !isset($this->configuration['grouping_fields']) && $this
          ->testField($name, $field)) {
          $supported_fields['default_fields'][$name] = $name;
        }
        $supported_fields['field_sorts'][$name] = $field
          ->getLabel();
      }
    }
    return $supported_fields;
  }

  /**
   * {@inheritdoc}
   */
  public function preprocessSearchQuery(QueryInterface $query) {
    $grouping_fields = $this
      ->getGroupingFields();
    if (!empty($grouping_fields)) {

      // We move the options from our options array into where the Solr Service
      // is expecting them.
      $options = [
        'use_grouping' => TRUE,
        'grouping_fields' => $grouping_fields,
        'truncate' => isset($this->configuration['truncate']) ? $this->configuration['truncate'] : TRUE,
        'group_limit' => isset($this->configuration['group_limit']) ? $this->configuration['group_limit'] : NULL,
        'group_sort' => [],
      ];
      if (!empty($this->configuration['group_sort'])) {
        $options['group_sort'][$this->configuration['group_sort']] = isset($this->configuration['group_sort_direction']) ? $this->configuration['group_sort_direction'] : 'asc';
      }
      $query
        ->setOption('search_api_grouping', $options);
    }
  }

  /**
   * Returns the fields to group on.
   *
   * @return array
   *   The list of fields to use for grouping.
   */
  public function getGroupingFields() {
    $fields = $this->configuration['grouping_fields'];
    foreach ($fields as $key => $field) {
      if ($field === 0) {
        unset($fields[$key]);
      }
    }
    return $fields;
  }

  /**
   * Form validation handler.
   *
   * @param array $form
   *   An associative array containing the structure of the plugin form as built
   *   by static::buildConfigurationForm().
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form. Calling code should pass on a subform
   *   state created through
   *   \Drupal\Core\Form\SubformState::createForSubform().
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    $results_per_group = $form['group_limit']['#value'];
    if (!ctype_digit($results_per_group)) {
      $title = $form["group_limit"]["#title"];
      $form_state
        ->setError($form["group_limit"], sprintf('%s must be numeric', $title));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigurablePluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
ConfigurablePluginBase::calculatePluginDependencies Deprecated protected function Calculates and adds dependencies of a specific plugin instance.
ConfigurablePluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConfigurablePluginBase::getDescription public function Returns the plugin's description. Overrides ConfigurablePluginInterface::getDescription
ConfigurablePluginBase::getPluginDependencies Deprecated protected function Calculates and returns dependencies of a specific plugin instance.
ConfigurablePluginBase::label public function Returns the label for use on the administration pages. Overrides ConfigurablePluginInterface::label
ConfigurablePluginBase::moduleHandler Deprecated protected function Wraps the module handler.
ConfigurablePluginBase::onDependencyRemoval public function Informs the plugin that some of its dependencies are being removed. Overrides ConfigurablePluginInterface::onDependencyRemoval 5
ConfigurablePluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration 3
ConfigurablePluginBase::themeHandler Deprecated protected function Wraps the theme handler.
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.
FieldsProcessorPluginBase::$dataTypeHelper protected property The data type helper. 1
FieldsProcessorPluginBase::$elementInfoManager protected property The element info manager.
FieldsProcessorPluginBase::create public static function Creates an instance of the plugin. Overrides ProcessorPluginBase::create 1
FieldsProcessorPluginBase::getDataTypeHelper public function Retrieves the data type helper. 1
FieldsProcessorPluginBase::getElementInfoManager public function Retrieves the element info manager.
FieldsProcessorPluginBase::preIndexSave public function Preprocesses the search index entity before it is saved. Overrides ProcessorPluginBase::preIndexSave
FieldsProcessorPluginBase::preprocessIndexItems public function Preprocesses search items for indexing. Overrides ProcessorPluginBase::preprocessIndexItems 1
FieldsProcessorPluginBase::preRenderFieldsCheckboxes public static function Preprocesses the "fields" checkboxes before rendering.
FieldsProcessorPluginBase::process protected function Processes a single string value. 8
FieldsProcessorPluginBase::processConditions protected function Preprocesses the query conditions.
FieldsProcessorPluginBase::processConditionValue protected function Processes a single condition value. 1
FieldsProcessorPluginBase::processField protected function Processes a single field's value. 3
FieldsProcessorPluginBase::processFieldValue protected function Processes a single text element in a field. 3
FieldsProcessorPluginBase::processKey protected function Processes a single search keyword. 1
FieldsProcessorPluginBase::processKeys protected function Preprocesses the search keywords.
FieldsProcessorPluginBase::setDataTypeHelper public function Sets the data type helper. 1
FieldsProcessorPluginBase::setElementInfoManager public function Sets the element info manager.
FieldsProcessorPluginBase::shouldProcess protected function Determines whether a single value (not an array) should be processed. 1
FieldsProcessorPluginBase::testField protected function Tests whether a certain field should be processed. 1
FieldsProcessorPluginBase::testType protected function Determines whether a field of a certain type should be preprocessed. 4
FieldsProcessorPluginBase::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks
Grouping::buildConfigurationForm public function Return the settings form for this processor. Overrides FieldsProcessorPluginBase::buildConfigurationForm
Grouping::defaultConfiguration public function Gets default configuration for this plugin. Overrides FieldsProcessorPluginBase::defaultConfiguration
Grouping::getGroupingFields public function Returns the fields to group on.
Grouping::getSupportedFields public function Returns an array of supported fields to choose of.
Grouping::preprocessSearchQuery public function Preprocesses a search query. Overrides FieldsProcessorPluginBase::preprocessSearchQuery
Grouping::submitConfigurationForm public function Form submission handler. Overrides PluginFormTrait::submitConfigurationForm
Grouping::validateConfigurationForm public function Form validation handler. Overrides FieldsProcessorPluginBase::validateConfigurationForm
IndexPluginBase::$index protected property The index this processor is configured for.
IndexPluginBase::getIndex public function Retrieves the index this plugin is configured for. Overrides IndexPluginInterface::getIndex
IndexPluginBase::setIndex public function Sets the index this plugin is configured for. Overrides IndexPluginInterface::setIndex
IndexPluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides ConfigurablePluginBase::__construct 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.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. Aliased as: traitCalculatePluginDependencies 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance. Aliased as: traitGetPluginDependencies
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. Aliased as: traitModuleHandler 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. Aliased as: traitThemeHandler 1
ProcessorInterface::STAGE_ADD_PROPERTIES constant Processing stage: add properties.
ProcessorInterface::STAGE_ALTER_ITEMS constant Processing stage: alter indexed items.
ProcessorInterface::STAGE_POSTPROCESS_QUERY constant Processing stage: postprocess query.
ProcessorInterface::STAGE_PREPROCESS_INDEX constant Processing stage: preprocess index.
ProcessorInterface::STAGE_PREPROCESS_QUERY constant Processing stage: preprocess query.
ProcessorInterface::STAGE_PRE_INDEX_SAVE constant Processing stage: preprocess index.
ProcessorPluginBase::$fieldsHelper protected property The fields helper. 1
ProcessorPluginBase::addFieldValues public function Adds the values of properties defined by this processor to the item. Overrides ProcessorInterface::addFieldValues 8
ProcessorPluginBase::alterIndexedItems public function Alter the items to be indexed. Overrides ProcessorInterface::alterIndexedItems 3
ProcessorPluginBase::ensureField protected function Ensures that a field with certain properties is indexed on the index.
ProcessorPluginBase::findField protected function Finds a certain field in the index.
ProcessorPluginBase::getFieldsHelper public function Retrieves the fields helper. 1
ProcessorPluginBase::getPropertyDefinitions public function Retrieves the properties this processor defines for the given datasource. Overrides ProcessorInterface::getPropertyDefinitions 8
ProcessorPluginBase::getWeight public function Returns the weight for a specific processing stage. Overrides ProcessorInterface::getWeight
ProcessorPluginBase::isHidden public function Determines whether this plugin should be hidden in the UI. Overrides HideablePluginBase::isHidden
ProcessorPluginBase::isLocked public function Determines whether this processor should always be enabled. Overrides ProcessorInterface::isLocked
ProcessorPluginBase::postprocessSearchResults public function Postprocess search results before they are returned by the query. Overrides ProcessorInterface::postprocessSearchResults 2
ProcessorPluginBase::requiresReindexing public function Determines whether re-indexing is required after a settings change. Overrides ProcessorInterface::requiresReindexing
ProcessorPluginBase::setFieldsHelper public function Sets the fields helper. 1
ProcessorPluginBase::setWeight public function Sets the weight for a specific processing stage. Overrides ProcessorInterface::setWeight
ProcessorPluginBase::supportsIndex public static function Checks whether this processor is applicable for a certain index. Overrides ProcessorInterface::supportsIndex 8
ProcessorPluginBase::supportsStage public function Checks whether this processor implements a particular stage. Overrides ProcessorInterface::supportsStage 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.
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.