You are here

Home » API reference » Views Table Rowspan 7 » views_plugin_display_table_rowspan.inc

class views_plugin_display_table_rowspan in Views Table Rowspan 7

Style plugin to merge duplicate row in table.

Hierarchy

Expanded class hierarchy of views_plugin_display_table_rowspan

1 string reference to 'views_plugin_display_table_rowspan'
views_table_rowspan_views_plugins in views/views_table_rowspan.views.inc
Implements hook_views_plugins().

File

views/plugins/views_plugin_display_table_rowspan.inc, line 13
Views handler display Table Rowspan.

View source 
class views_plugin_display_table_rowspan extends views_plugin_style_table {

  /**
   * Overwrite method option_definition().
   *
   * Add new option 'rowspan'.
   */
  function option_definition() {
    $options = parent::option_definition();

    // Option to merge duplicate rows in to one row.
    $options['rowspan'] = array(
      'default' => TRUE,
    );
    return $options;
  }

  /**
   * Overwrite method options_form().
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['rowspan'] = array(
      '#type' => 'checkbox',
      '#title' => t('Merge rows in table'),
      '#description' => t('Merge rows table that has same value (in a same group) use attribute !url', array(
        '!url' => '<a href="http://www.w3schools.com/tags/att_td_rowspan.asp">rowspan.</a>',
      )),
      '#default_value' => $this->options['rowspan'],
      '#weight' => 0,
    );
  }

  /**
   * Overwrite method render_grouping_sets().
   *
   * Merge all group in one table, then merge duplidate row to one row.
   */
  function render_grouping_sets($sets, $level = 0) {
    if (!empty($this->options['grouping'])) {
      if (!empty($this->options['rowspan'])) {
        $rows = $this
          ->get_colspan_rows($sets);
        $sets = array(
          array(
            'group' => '',
            'rows' => $rows,
          ),
        );

        // Convert sets to one group.
        $this->options['grouping'] = array();
      }
    }
    return parent::render_grouping_sets($sets, $level);
  }

  /**
   * Convert grouping sets into table rows.
   *
   * @param array $sets
   *   Views grouping sets.
   *
   * @return array
   *   An array of rows in table.
   */
  protected function get_colspan_rows($sets, $level = 0, $parent = NULL) {
    $rows = array();
    $leaf_rows = array();
    $group_field_name = $this->options['grouping'][$level]['field'];
    foreach ($sets as $set) {
      $new_level = $level + 1;
      $leaf_rows = $this
        ->_get_deepest_row($set);
      $leaf_rows_index = array_keys($leaf_rows);
      $first_index = $leaf_rows_index[0];
      $this->view->rowspan[$group_field_name][$first_index] = $leaf_rows_index;
      $row = reset($set['rows']);
      if (is_array($row) && isset($row['group'])) {
        $rows += $this
          ->get_colspan_rows($set['rows'], $new_level, $set);
      }
      else {
        foreach ($set['rows'] as $index => $set_row) {
          $rows[$index] = $set_row;
        }
      }
    }
    return $rows;
  }

  /**
   * Get deepest rows in a group.
   *
   * @param array $set
   *   View grouping set.
   */
  protected function _get_deepest_row($set) {
    $row = reset($set['rows']);

    // Check set is a group or a row.
    if (is_array($row) && isset($row['group'])) {
      $result = array();
      foreach ($set['rows'] as $sub_set) {
        $subset_result = $this
          ->_get_deepest_row($sub_set);
        $result += $subset_result;
      }
      return $result;
    }
    else {
      $_result = array();
      foreach ($set['rows'] as $row_index => $row) {
        $_result[$row_index] = $row;
      }
      return $_result;
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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_display_table_rowspan::get_colspan_rows protected function Convert grouping sets into table rows.
views_plugin_display_table_rowspan::options_form function Overwrite method options_form(). Overrides views_plugin_style_table::options_form
views_plugin_display_table_rowspan::option_definition function Overwrite method option_definition(). Overrides views_plugin_style_table::option_definition
views_plugin_display_table_rowspan::render_grouping_sets function Overwrite method render_grouping_sets(). Overrides views_plugin_style::render_grouping_sets
views_plugin_display_table_rowspan::_get_deepest_row protected function Get deepest rows in a group.
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::destroy public function Destructor. Overrides views_object::destroy
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::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::render_grouping public function Group records as needed for rendering.
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
views_plugin_style_table::$active public property Contains the current active sort column.
views_plugin_style_table::$order public property Contains the current active sort order, either desc or asc.
views_plugin_style_table::build_sort public function Determine if we should provide sorting based upon $_GET inputs Overrides views_plugin_style::build_sort
views_plugin_style_table::build_sort_post public function Add our actual sort criteria Overrides views_plugin_style::build_sort_post
views_plugin_style_table::even_empty public function Should the output of the style plugin be rendered even if it's empty. Overrides views_plugin_style::even_empty
views_plugin_style_table::sanitize_columns public function Normalize a list of columns based upon the fields that are available. This compares the fields stored in the style handler to the list of fields actually in the view, removing fields that have been removed and adding new fields in their own column.