You are here

Home » API reference » Views Merge Rows 8 » views_merge_rowsDisplayExtenderPlugin.php

class Views_Merge_RowsDisplayExtenderPlugin in Views Merge Rows 8

Plugin annotation


@ViewsDisplayExtender(
  id = "views_merge_rows",
  title = @Translation("Merge rows"),
  help = @Translation("Merges rows with the same values in the specified fields."),
  no_ui = FALSE
)

Hierarchy

Expanded class hierarchy of Views_Merge_RowsDisplayExtenderPlugin

File

src/Plugin/views/display_extender/views_merge_rowsDisplayExtenderPlugin.php, line 22
Contains the class to extend views display with rows merge functionality.

Namespace

Drupal\views_merge_rows\Plugin\views\display_extender
View source 
class Views_Merge_RowsDisplayExtenderPlugin extends DisplayExtenderPluginBase {

  /**
   * Provide a list of options for this plugin.
   */
  public function defineOptionsAlter(&$options) {
    $options['merge_rows'] = [
      'default' => FALSE,
      'bool' => TRUE,
    ];
    $options['use_grouping'] = [
      'default' => FALSE,
      'bool' => TRUE,
    ];
    $options['field_config'] = [
      'default' => [],
    ];
  }

  /**
   * Returns configuration for row merging.
   *
   * Only returns the configuration for the fields present in the view.
   * If a new field was added to the view, the default configuration for this
   * field is returned.
   *
   * @return array
   *   Configuration for row merging.
   */
  public function get_options() {
    if ($this->displayHandler
      ->usesFields()) {
      $options = [];
      $options['merge_rows'] = $this->displayHandler
        ->getOption('merge_rows');
      if (empty($options['merge_rows'])) {
        $options['merge_rows'] = FALSE;
      }
      $options['use_grouping'] = $this->displayHandler
        ->getOption('use_grouping');
      if (empty($options['use_grouping'])) {
        $options['use_grouping'] = FALSE;
      }
      $options['field_config'] = [];
      $field_config = $this->displayHandler
        ->getOption('field_config');
      $fields = $this->displayHandler
        ->getOption('fields');
      foreach ($fields as $field => $info) {
        if (isset($field_config[$field])) {
          $options['field_config'][$field] = $field_config[$field];
        }
        else {
          $options['field_config'][$field] = [
            'merge_option' => 'merge_unique',
            'exclude_first' => FALSE,
            'prefix' => '',
            'separator' => ', ',
            'suffix' => '',
          ];
        }
      }
    }
    else {
      $options['merge_rows'] = FALSE;
      $options['use_grouping'] = FALSE;
      $options['field_config'] = [];
    }
    return $options;
  }

  /**
   * Provide the form to set the rows merge options.
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    $this
      ->views_merge_rows_options_form_build($form, $form_state);
  }

  /**
   * Handle any special handling on the validate form.
   */
  public function submitOptionsForm(&$form, FormStateInterface $form_state) {
    $this
      ->views_merge_rows_options_form_submit($form, $form_state);
  }

  /**
   * Provide the default summary for options in the views UI.
   *
   * This output is returned as an array.
   */
  public function optionsSummary(&$categories, &$options) {
    if ($this->displayHandler
      ->usesFields()) {
      $configuration = $this
        ->get_options();
      $options['views_merge_rows'] = [
        'category' => 'other',
        'title' => t('Merge rows'),
        'value' => $configuration['merge_rows'] ? t('Settings') : t('No'),
        'desc' => t('Allow merging rows with the same content in the specified fields.'),
      ];
    }
  }

  /**
   * Provide a form to edit options for this plugin.
   */
  protected function views_merge_rows_options_form_build(&$form, FormStateInterface $form_state) {
    if ($form_state
      ->get('section') == 'views_merge_rows') {
      $options = $this
        ->get_options();
      if ($this->displayHandler
        ->usesPager()) {
        $form['warning_markup'] = [
          '#markup' => '<div class="warning messages">' . t('It is highly recommended to disable pager if you merge rows.') . '</div>',
        ];
      }
      else {
        $form['warning_markup'] = [];
      }
      $form['#tree'] = TRUE;
      $form['#theme'] = 'merge_rows_theme';
      $form['#title'] .= t('Merge rows with the same content.');
      $form['merge_rows'] = [
        '#type' => 'checkbox',
        '#title' => t('Merge rows with the same content in the specified fields'),
        '#default_value' => $options['merge_rows'],
      ];
      $form['use_grouping'] = [
        '#type' => 'checkbox',
        '#title' => t('Merge rows using the grouping defined in the base view'),
        '#default_value' => $options['use_grouping'],
      ];

      // Create an array of allowed columns from the data we know:
      $field_names = $this->displayHandler
        ->getFieldLabels();
      foreach ($field_names as $field => $name) {
        $safe = str_replace([
          '][',
          '_',
          ' ',
        ], '-', $field);

        // Markup for the field name.
        $form['field_config'][$field]['name'] = [
          '#markup' => $name,
        ];

        // Select for merge options.
        $form['field_config'][$field]['merge_option'] = [
          '#type' => 'select',
          '#options' => [
            'filter' => t('Use values of this field as a filter'),
            'merge' => t('Merge values of this field'),
            'merge_unique' => t('Merge unique values of this field'),
            'first_value' => t('Use the first value of this field'),
            'highest_value' => t('Use the highest value of this field'),
            'lowest_value' => t('Use the lowest value of this field'),
            'average' => t('Use the average value of this field'),
            'std_deviation' => t('Use the sample standard deviation of this field'),
            'sum' => t('Sum values of this field'),
            'count' => t('Count merged values of this field'),
            'count_unique' => t('Count merged unique values of this field'),
          ],
          '#default_value' => $options['field_config'][$field]['merge_option'],
        ];
        $form['field_config'][$field]['exclude_first'] = [
          '#title' => t(''),
          '#type' => 'checkbox',
          '#default_value' => $options['field_config'][$field]['exclude_first'],
        ];
        $form['field_config'][$field]['prefix'] = [
          '#id' => 'views-merge-rows-prefix',
          '#title' => t(''),
          '#type' => 'textfield',
          '#size' => 10,
          '#default_value' => $options['field_config'][$field]['prefix'],
          '#dependency' => [
            'edit-options-field-config-' . $safe . '-merge-option' => [
              'merge',
              'merge_unique',
            ],
          ],
        ];
        $form['field_config'][$field]['separator'] = [
          '#id' => 'views-merge-rows-separator',
          '#title' => t(''),
          '#type' => 'textfield',
          '#size' => 10,
          '#default_value' => $options['field_config'][$field]['separator'],
          '#dependency' => [
            'edit-options-field-config-' . $safe . '-merge-option' => [
              'merge',
              'merge_unique',
            ],
          ],
        ];
        $form['field_config'][$field]['suffix'] = [
          '#id' => 'views-merge-rows-suffix',
          '#title' => t(''),
          '#type' => 'textfield',
          '#size' => 10,
          '#default_value' => $options['field_config'][$field]['suffix'],
          '#dependency' => [
            'edit-options-field-config-' . $safe . '-merge-option' => [
              'merge',
              'merge_unique',
            ],
          ],
        ];
      }
    }
  }

  /**
   * Saves the row merge options.
   */
  protected function views_merge_rows_options_form_submit(&$form, FormStateInterface $form_state) {
    foreach ($form_state
      ->getValue('options') as $option => $value) {
      $this->displayHandler
        ->setOption($option, $value);
    }
  }

}

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
DisplayExtenderPluginBase::defaultableSections public function Static member function to list which sections are defaultable and what items each section contains. 1
DisplayExtenderPluginBase::preExecute public function Set up any variables on the view prior to execution. 1
DisplayExtenderPluginBase::query public function Inject anything into the query that the display_extender handler needs. Overrides PluginBase::query 1
DisplayExtenderPluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm
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::$definition public property Plugins's definition
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$renderer protected property Stores the render API renderer. 3
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
PluginBase::$view public property The top object of a view. 1
PluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 14
PluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 62
PluginBase::defineOptions protected function Information about options for all kinds of purposes will be held here. 18
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function Clears a plugin. Overrides ViewsPluginInterface::destroy 2
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
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::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer. 1
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY constant Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED constant Include negotiated languages when listing languages.
PluginBase::init public function Initialize the plugin. Overrides ViewsPluginInterface::init 8
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions public static function Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::summaryTitle public function Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions 1
PluginBase::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks 6
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. Overrides ViewsPluginInterface::validate 6
PluginBase::viewsTokenReplace protected function Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. 1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
PluginBase::__construct public function Constructs a PluginBase object. Overrides PluginBase::__construct
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.
Views_Merge_RowsDisplayExtenderPlugin::buildOptionsForm public function Provide the form to set the rows merge options. Overrides DisplayExtenderPluginBase::buildOptionsForm
Views_Merge_RowsDisplayExtenderPlugin::defineOptionsAlter public function Provide a list of options for this plugin. Overrides DisplayExtenderPluginBase::defineOptionsAlter
Views_Merge_RowsDisplayExtenderPlugin::get_options public function Returns configuration for row merging.
Views_Merge_RowsDisplayExtenderPlugin::optionsSummary public function Provide the default summary for options in the views UI. Overrides DisplayExtenderPluginBase::optionsSummary
Views_Merge_RowsDisplayExtenderPlugin::submitOptionsForm public function Handle any special handling on the validate form. Overrides DisplayExtenderPluginBase::submitOptionsForm
Views_Merge_RowsDisplayExtenderPlugin::views_merge_rows_options_form_build protected function Provide a form to edit options for this plugin.
Views_Merge_RowsDisplayExtenderPlugin::views_merge_rows_options_form_submit protected function Saves the row merge options.