You are here

Home » API reference » Views Complex Grouping 7 » views_complex_grouping_style_plugin.inc

class views_complex_grouping_style_plugin in Views Complex Grouping 7

@file views_grouping_complex_style_plugin.inc Our handler.

Hierarchy

Expanded class hierarchy of views_complex_grouping_style_plugin

1 string reference to 'views_complex_grouping_style_plugin'
views_complex_grouping_views_plugins in ./views_complex_grouping.views.inc
Implements hook_views_plugins().

File

./views_complex_grouping_style_plugin.inc, line 8
views_grouping_complex_style_plugin.inc Our handler.

View source 
class views_complex_grouping_style_plugin extends views_plugin_style {

  /**
   * Overrides parent::options_form().
   *
   * Add our options to the form.
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $field_labels = $this->display->handler
      ->get_field_labels();
    foreach ($form['grouping'] as $index => $info) {
      $grouping_fields_default = isset($this->options['grouping'][$index]['grouping-complex']['grouping-fields']) ? $this->options['grouping'][$index]['grouping-complex']['grouping-fields'] : NULL;
      $grouping_limit_default = isset($this->options['grouping'][$index]['grouping-complex']['grouping-limit']) ? $this->options['grouping'][$index]['grouping-complex']['grouping-limit'] : 1;
      $grouping_offset_default = isset($this->options['grouping'][$index]['grouping-complex']['grouping-offset']) ? $this->options['grouping'][$index]['grouping-complex']['grouping-offset'] : 1;
      $form['grouping'][$index]['grouping-complex'] = array(
        '#type' => 'fieldset',
        '#title' => t('Limit and extra fields for grouping field Nr.!num', array(
          '!num' => $index + 1,
        )),
        '#collapsible' => TRUE,
        '#collapsed' => TRUE,
        'grouping-fields' => array(
          '#type' => 'select',
          '#multiple' => TRUE,
          '#title' => t('Selected'),
          '#options' => $field_labels,
          '#default_value' => $grouping_fields_default,
          '#description' => t('Select which fields will be displayed alongside the field Nr.!num', array(
            '!num' => $index + 1,
          )),
        ),
        'grouping-limit' => array(
          '#type' => 'textfield',
          '#title' => t('Items to display:'),
          '#default_value' => $grouping_limit_default,
          '#size' => 6,
          '#element_validate' => array(
            'views_complex_grouping_validate',
          ),
          '#description' => t('The number of rows to show under the field Nr.!num. Leave 0 to show all of them.', array(
            '!num' => $index + 1,
          )),
        ),
        'grouping-offset' => array(
          '#type' => 'textfield',
          '#title' => t('Offset:'),
          '#default_value' => $grouping_offset_default,
          '#size' => 6,
          '#element_validate' => array(
            'views_complex_grouping_validate',
          ),
          '#description' => t('The row to start on.'),
        ),
      );
    }
  }

  /**
   * Overrides parent::render_grouping().
   */
  function render_grouping($records, $groupings = array(), $group_rendered = NULL) {

    // This is for backward compability, when $groupings was a string containing
    // the ID of a single field.
    if (is_string($groupings)) {
      $rendered = $group_rendered === NULL ? TRUE : $group_rendered;
      $groupings = array(
        array(
          'field' => $groupings,
          'rendered' => $rendered,
        ),
      );
    }

    // Make sure fields are rendered
    $this
      ->render_fields($this->view->result);
    $sets = array();
    if ($groupings) {
      foreach ($records as $index => $row) {

        // Iterate through configured grouping fields to determine the
        // hierarchically positioned set where the current row belongs to.
        // While iterating, parent groups, that do not exist yet, are added.
        $set =& $sets;
        foreach ($groupings as $level => $info) {
          $field = $info['field'];
          $rendered = isset($info['rendered']) ? $info['rendered'] : $group_rendered;
          $rendered_strip = isset($info['rendered_strip']) ? $info['rendered_strip'] : FALSE;
          $grouping = '';
          $group_content = '';

          // Group on the rendered version of the field, not the raw.  That way,
          // we can control any special formatting of the grouping field through
          // the admin or theme layer or anywhere else we'd like.
          if (isset($this->view->field[$field])) {
            $group_content = $this
              ->get_field($index, $field);

            //dpm($group_content);
            if ($this->view->field[$field]->options['label']) {
              $group_content = $this->view->field[$field]->options['label'] . ': ' . $group_content;
            }
            if ($rendered) {
              $grouping = $group_content;
              if ($rendered_strip) {
                $group_content = $grouping = strip_tags(htmlspecialchars_decode($group_content));
              }
            }
            else {
              $grouping = $this
                ->get_field_value($index, $field);

              // Not all field handlers return a scalar value,
              // e.g. views_handler_field_field.
              if (!is_scalar($grouping)) {
                $grouping = md5(serialize($grouping));
              }
            }
          }

          // Create the group if it does not exist yet.
          if (empty($set[$grouping])) {
            $set[$grouping]['group'] = $group_content;
            $set[$grouping]['rows'] = array();
            $set[$grouping]['level'] = $level;
            $set[$grouping]['fields'] = array();

            // Add selected fields for this level.
            foreach ($this->options['grouping'][$level]['grouping-complex']['grouping-fields'] as $field) {
              $set[$grouping]['fields'][$field] = $this->rendered_fields[$index][$field];
            }
          }

          // Move the set reference into the row set of the group we just determined.
          $set =& $set[$grouping]['rows'];
        }

        // Add the row to the hierarchically positioned row set we just determined.
        $set[$index] = $row;
      }
    }
    else {

      // Create a single group with an empty grouping field.
      $sets[''] = array(
        'group' => '',
        'rows' => $records,
      );
    }

    // If this parameter isn't explicitely set modify the output to be fully
    // backward compatible to code before Views 7.x-3.0-rc2.
    // @TODO Remove this as soon as possible e.g. October 2020
    if ($group_rendered === NULL) {
      $old_style_sets = array();
      foreach ($sets as $group) {
        $old_style_sets[$group['group']] = $group['rows'];
      }
      $sets = $old_style_sets;
    }

    // Apply the offset and limit.
    array_walk($sets, array(
      $this,
      'views_complex_grouping_limit_recursive',
    ));
    return $sets;
  }

  /**
   * Overrides parent::render_grouping_set().
   */
  function render_grouping_sets($sets, $level = 0) {
    $output = '';
    $branch = 0;
    foreach ($sets as $set) {
      $branch++;
      $row = reset($set['rows']);

      // Render as a grouping set.
      if (is_array($row) && isset($row['group'])) {
        $output .= theme(views_theme_functions('views_complex_grouping_level', $this->view, $this->display), array(
          'view' => $this->view,
          'grouping' => $this->options['grouping'][$level],
          'grouping_level' => $level + 1,
          'grouping_branch' => $branch,
          'rows' => $set['rows'],
          'fields' => $set['fields'],
          'title' => $set['group'],
        ));
      }
      else {
        if ($this
          ->uses_row_plugin()) {
          foreach ($set['rows'] as $index => $row) {
            $this->view->row_index = $index;
            $set['rows'][$index] = $this->row_plugin
              ->render($row);
          }
        }
        $output .= theme($this
          ->theme_functions(), array(
          'view' => $this->view,
          'options' => $this->options,
          'grouping_level' => $level + 1,
          'grouping_branch' => $branch,
          'rows' => $set['rows'],
          'fields' => $set['fields'],
          'title' => $set['group'],
        ));
      }
    }
    unset($this->view->row_index);
    return $output;
  }

  /**
   * Recursively limits the number of rows in nested groups.
   *
   * @param array $group_data
   *   A single level of grouped records.
   *
   * @param mixed $key
   *   The key of the array being passed in. Used for when this function is
   *   called from array_walk() and the like. Do not set directly.
   *
   * @params int $level
   *   The current level we are gathering results for. Used for recursive
   *   operations; do not set directly.
   *
   * @return array
   *   An array with a "rows" property that is recursively grouped by the
   *   grouping fields.
   */
  function views_complex_grouping_limit_recursive(&$group_data, $key = NULL, $level = 1) {
    $settings = $this
      ->views_complex_grouping_settings($level - 1);
    $settings['grouping-limit'] = $settings['grouping-limit'] != 0 ? $settings['grouping-limit'] : NULL;
    $settings['grouping-offset'] = isset($settings['grouping-offset']) ? $settings['grouping-offset'] : 0;

    // Slice up the rows according to the offset and limit.
    $group_data['rows'] = array_slice($group_data['rows'], $settings['grouping-offset'], $settings['grouping-limit'], TRUE);

    // For each row, if it appears to be another grouping, recurse again.
    foreach ($group_data['rows'] as &$data) {
      if (is_array($data) && isset($data['group']) && isset($data['rows'])) {
        $this
          ->views_complex_grouping_limit_recursive($data, NULL, $level + 1);
      }
    }
  }

  /**
   * Helper function to retrieve settings for grouping limit.
   *
   * @param int $index
   *   The grouping level to fetch settings for.
   *
   * @return array
   *   Settings for this grouping level.
   */
  function views_complex_grouping_settings($index) {
    if ($this->options['grouping'][$index] && $this->options['grouping'][$index]['grouping-complex']) {
      return $this->options['grouping'][$index]['grouping-complex'];
    }
    else {
      return array(
        'grouping-limit' => 0,
        'grouping-offset' => 0,
      );
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
views_complex_grouping_style_plugin::options_form function Overrides parent::options_form(). Overrides views_plugin_style::options_form
views_complex_grouping_style_plugin::render_grouping function Overrides parent::render_grouping(). Overrides views_plugin_style::render_grouping
views_complex_grouping_style_plugin::render_grouping_sets function Overrides parent::render_grouping_set(). Overrides views_plugin_style::render_grouping_sets
views_complex_grouping_style_plugin::views_complex_grouping_limit_recursive function Recursively limits the number of rows in nested groups.
views_complex_grouping_style_plugin::views_complex_grouping_settings function Helper function to retrieve settings for grouping limit.
views_object::$definition public property Handler's definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition function Collect this handler's option definition and alter them, ready for use.
views_object::construct public function Views handlers use a special construct function. 4
views_object::export_option public function 1
views_object::export_options public function
views_object::export_option_always public function Always exports the option, regardless of the default value.
views_object::options Deprecated public function Set default options on this object. 1
views_object::set_default_options public function Set default options.
views_object::set_definition public function Let the handler know what its full definition is.
views_object::unpack_options public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable public function Unpack a single option definition.
views_object::unpack_translatables public function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults public function
views_plugin::$display public property The current used views display.
views_plugin::$plugin_name public property The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type public property The plugin type of this plugin, for example style or query.
views_plugin::$view public property The top object of a view. Overrides views_object::$view 1
views_plugin::additional_theme_functions public function Provide a list of additional theme functions for the theme info page.
views_plugin::options_submit public function Handle any special handling on the validate form. 9
views_plugin::plugin_title public function Return the human readable name of the display.
views_plugin::summary_title public function Returns the summary of the settings in the display. 8
views_plugin::theme_functions public function Provide a full list of possible theme templates used by this style.
views_plugin_style::$row_plugin public property The row plugin, if it's initialized and the style itself supports it.
views_plugin_style::$row_tokens public property Store all available tokens row rows.
views_plugin_style::build_sort public function Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query. 1
views_plugin_style::build_sort_post public function Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view. 1
views_plugin_style::destroy public function Destructor. Overrides views_object::destroy
views_plugin_style::even_empty public function Should the output of the style plugin be rendered even if it's empty. 1
views_plugin_style::get_field public function Get a rendered field.
views_plugin_style::get_field_value public function Get the raw field value.
views_plugin_style::get_row_class public function Return the token replaced row class for the specified row.
views_plugin_style::init public function Initialize a style plugin.
views_plugin_style::options_validate public function Validate the options form. Overrides views_plugin::options_validate
views_plugin_style::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_object::option_definition 8
views_plugin_style::pre_render public function Allow the style to do stuff before each row is rendered.
views_plugin_style::query public function Add anything to the query that we might need to. Overrides views_plugin::query 2
views_plugin_style::render public function Render the display in this style. 5
views_plugin_style::render_fields public function Render all of the fields for a given style and store them on the object.
views_plugin_style::tokenize_value public function Take a value and apply token replacement logic to it.
views_plugin_style::uses_fields public function Return TRUE if this style also uses fields.
views_plugin_style::uses_row_class public function Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_row_plugin public function Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_tokens public function Return TRUE if this style uses tokens.
views_plugin_style::validate public function Validate that the plugin is correct and can be saved. Overrides views_plugin::validate