sheetnode_handler_field_range.inc in Sheetnode 7.2

Views handler for sheetnode ranges.

File

views/sheetnode_handler_field_range.inc

<?php

/**
 * @file
 * Views handler for sheetnode ranges.
 */

/**
 * Provides a custom sheetnode ranges handler.
 */
class sheetnode_handler_field_range extends views_handler_field {

  /**
   * Set field options definition.
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['reference'] = array(
      'default' => '',
    );
    $options['labels'] = array(
      'default' => SHEETNODE_RANGE_LABELS_ROW_COL,
    );
    $options['raw'] = array(
      'default' => FALSE,
    );
    return $options;
  }

  /**
   * Set field options form.
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['reference'] = array(
      '#type' => 'textfield',
      '#title' => t('Range reference'),
      '#default_value' => $this->options['reference'],
      '#description' => t('Use the format A1:C4 for a cell range, A for whole column, 1 for whole row.'),
    );
    $form['labels'] = array(
      '#type' => 'radios',
      '#title' => t('Labels'),
      '#options' => array(
        0 => t('None'),
        SHEETNODE_RANGE_LABELS_ROW => t('Rows only'),
        SHEETNODE_RANGE_LABELS_COL => t('Columns only'),
        SHEETNODE_RANGE_LABELS_ROW_COL => t('Rows and columns'),
      ),
      '#default_value' => $this->options['labels'],
      '#description' => t('Select whether row or column labels should appear.'),
    );
    $form['raw'] = array(
      '#type' => 'checkbox',
      '#title' => t('Raw value'),
      '#default_value' => $this->options['raw'],
      '#description' => t('Return raw PHP cell array instead of themed value. Useful for inserting into an output spreadsheet.'),
    );
  }

  /**
   * Render views field.
   */
  function render($values) {
    module_load_include('inc', 'sheetnode', 'socialcalc');
    $sheet = $values->{$this->field_alias};
    if (empty($sheet)) {
      return NULL;
    }
    $sc = socialcalc_parse_sheet($sheet);

    // Parse the range reference.
    $range = preg_split('/:/', $this->options['reference'], 2);
    $start = socialcalc_coord_to_cr($range[0]);
    $end = socialcalc_coord_to_cr(isset($range[1]) ? $range[1] : $range[0]);
    if (empty($end[0])) {
      $end[0] = $sc['attribs']['lastcol'];
    }
    if (empty($end[1])) {
      $end[1] = $sc['attribs']['lastrow'];
    }

    // Build the range of values.
    $range = array();
    for ($r = $start[1]; $r <= $end[1]; $r++) {
      for ($c = $start[0]; $c <= $end[0]; $c++) {
        $coord = socialcalc_cr_to_coord($c, $r);
        $range[$coord] = !empty($sc['cells'][$coord]['datavalue']) ? $sc['cells'][$coord]['datavalue'] : NULL;
      }
    }

    // Return themed or raw values.
    return $this->options['raw'] ? $range : theme('sheetnode_range', array(
      'range' => $range,
      'labels' => $this->options['labels'],
    ));
  }

}

Classes

Name	Description
sheetnode_handler_field_range	Provides a custom sheetnode ranges handler.