You are here

Home » API reference » Views Grouping Row Limit 7 » views_limit_grouping_style_plugin.inc

class views_limit_grouping_style_plugin in Views Grouping Row Limit 7

Same name and namespace in other branches
  1. 6 views_limit_grouping_style_plugin.inc \views_limit_grouping_style_plugin

@file views_grouping_limit_style_plugin.inc Our handler.

Hierarchy

Expanded class hierarchy of views_limit_grouping_style_plugin

1 string reference to 'views_limit_grouping_style_plugin'
views_limit_grouping_views_plugins in ./views_limit_grouping.views.inc
Implements hook_views_plugins().

File

./views_limit_grouping_style_plugin.inc, line 8
views_grouping_limit_style_plugin.inc Our handler.

View source 
class views_limit_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);
    foreach ($form['grouping'] as $index => $info) {
      $defaults = $this
        ->grouping_limit_settings($index);
      $form['grouping'][$index]['grouping-limit'] = array(
        '#type' => 'fieldset',
        '#title' => t('Limit for grouping field Nr.!num', array(
          '!num' => $index + 1,
        )),
        '#collapsible' => TRUE,
        '#collapsed' => TRUE,
        '#states' => array(
          'invisible' => array(
            "select[name=\"style_options[grouping][{$index}][field]\"]" => array(
              'value' => '',
            ),
          ),
        ),
        'grouping-limit' => array(
          '#type' => 'textfield',
          '#title' => t('Items to display:'),
          '#default_value' => isset($defaults['grouping-limit']) ? $defaults['grouping-limit'] : 0,
          '#size' => 6,
          '#element_validate' => array(
            'grouping_validate',
          ),
          '#description' => t('The number of rows to show under each grouping header (only works when "Items to display" in the main view is set to unlimited).'),
        ),
        'grouping-offset' => array(
          '#type' => 'textfield',
          '#title' => t('Offset:'),
          '#default_value' => isset($defaults['grouping-offset']) ? $defaults['grouping-offset'] : 0,
          '#size' => 6,
          '#element_validate' => array(
            'grouping_validate',
          ),
          '#description' => t('The row to start on (<em>0</em> means it will start with first row, <em>1</em> means an offset of 1, and so on).'),
        ),
      );
    }
  }

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

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

  /**
   * 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 group_limit_recursive(&$group_data, $key = NULL, $level = 0) {
    $settings = $this
      ->grouping_limit_settings($level);

    // 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
          ->group_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 grouping_limit_settings($index) {
    return $this->options['grouping'][$index]['grouping-limit'];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
views_limit_grouping_style_plugin::grouping_limit_settings function Helper function to retrieve settings for grouping limit.
views_limit_grouping_style_plugin::group_limit_recursive function Recursively limits the number of rows in nested groups.
views_limit_grouping_style_plugin::options_form function Overrides parent::options_form(). Overrides views_plugin_style::options_form
views_limit_grouping_style_plugin::render_grouping function Overrides parent::render_grouping(). Overrides views_plugin_style::render_grouping
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::render_grouping_sets public function Render the grouping sets.
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