class flot_handler_field_datapoint in Flot 6

Hierarchy

• class \flot_handler_field_datapoint extends \views_handler_field

1 string reference to 'flot_handler_field_datapoint'

flot_views_data_alter in views/flot.views.inc

Implementation of hook_views_data_alter().

File

views/flot_handler_field_datapoint.inc, line 3

class flot_handler_field_datapoint extends views_handler_field {
  protected $use_date;

  /**
   * Disable advanced render.
   */
  function allow_advanced_render() {
    return FALSE;
  }

  /**
   * Option defaults.
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['series'] = array(
      'default' => array(
        'field' => '',
        'grouping' => '',
        'date_format' => 'small',
      ),
    );
    $options['value'] = array(
      'default' => array(
        'field' => '',
        'format' => '',
      ),
    );
    return $options;
  }

  /**
   * Options form.
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['series'] = array(
      '#tree' => TRUE,
      '#collapsible' => TRUE,
      '#type' => 'fieldset',
      '#title' => t('Series (X axis)'),
    );
    $form['series']['field'] = array(
      '#title' => t('Field'),
      '#type' => 'select',
      '#options' => array(),
      '#default_value' => $this->options['series']['field'],
    );
    $form['value'] = array(
      '#tree' => TRUE,
      '#collapsible' => TRUE,
      '#type' => 'fieldset',
      '#title' => t('Series (Y axis)'),
    );
    $form['value']['field'] = array(
      '#title' => t('Field'),
      '#type' => 'select',
      '#options' => array(),
      '#default_value' => $this->options['value']['field'],
    );

    // Get field options and generate subsequent options based on class
    foreach (views_fetch_fields($this->view->base_table, 'field') as $field_id => $field_info) {
      $form['series']['field']['#options'][$field_id] = !empty($field_info['title']) ? $field_info['title'] : $field_id;
      $form['value']['field']['#options'][$field_id] = !empty($field_info['title']) ? $field_info['title'] : $field_id;
      list($table, $field) = explode('.', $field_id);
      $handler = get_class(views_get_handler($table, $field, 'field'));
      if (strpos($handler, '_date') !== FALSE) {

        // If the series field is empty, use a date by default
        $form['series']['field']['#default_value'] = empty($form['series']['field']['#default_value']) ? $field_id : $form['series']['field']['#default_value'];
        if (!isset($form['series']['grouping'])) {
          $form['series']['grouping'] = array(
            '#title' => t('Group dates by'),
            '#type' => 'select',
            '#options' => array(
              'Y-m-d-H' => t('Hour'),
              'Y-m-d-3' => t('3 hours'),
              'Y-m-d-6' => t('6 hours'),
              'Y-m-d-A' => t('12 hours'),
              'Y-m-d' => t('Day'),
              'Y-m' => t('Month'),
              'Y' => t('Year'),
            ),
            '#process' => array(
              'views_process_dependency',
            ),
            '#dependency' => array(),
            '#default_value' => $this->options['series']['grouping'],
          );
          $form['series']['date_format'] = array(
            '#title' => t('Date format'),
            '#type' => 'select',
            '#options' => array(
              'small' => format_date(time(), 'small'),
              'medium' => format_date(time(), 'medium'),
              'large' => format_date(time(), 'large'),
            ),
            '#process' => array(
              'views_process_dependency',
            ),
            '#dependency' => array(),
            '#default_value' => $this->options['series']['date_format'],
          );
        }

        // Add this field to the list of timestamp options which trigger the grouping field display.
        $form['series']['grouping']['#dependency']['edit-options-series-field'][] = $field_id;
        $form['series']['date_format']['#dependency']['edit-options-series-field'][] = $field_id;
      }
    }
    $form['value']['format'] = array(
      '#title' => t('Format'),
      '#type' => 'select',
      '#options' => array(
        'raw' => t('Raw value'),
        'count' => t('Count'),
      ),
      '#default_value' => $this->options['value']['format'],
    );
  }

  /**
   * Query method.
   */
  function query() {

    // Killswitch
    if (empty($this->options['series']['field']) || empty($this->options['value']['field'])) {
      return;
    }

    // Yank off the base field & any other groupby's / having's. They will screw up our results.
    unset($this->query->fields[$this->view->base_field]);
    $this->query->groupby = array();
    $this->query->having = array();

    // Add in series field
    list($series_table, $series_field) = explode('.', $this->options['series']['field']);
    $alias = $this->query
      ->ensure_table($series_table);

    // Determine whether we are using a date field.
    $handler = get_class(views_get_handler($series_table, $series_field, 'field'));
    $this->use_date = strpos($handler, '_date') !== FALSE;
    $field_alias = $this->query
      ->add_field($series_table, $series_field);
    $this->query
      ->add_groupby($field_alias);
    $this->series_table = $alias;
    $this->series_field = $field_alias;

    // Add in value field
    list($value_table, $value_field) = explode('.', $this->options['value']['field']);
    $alias = $this->query
      ->ensure_table($value_table);
    if ($this->use_date) {
      $field_alias = $this->query
        ->add_field($value_table, $value_field);
    }
    else {
      switch ($this->options['value']['format']) {
        case 'count':
          $field_alias = $this->query
            ->add_field(NULL, "COUNT({$alias}.{$value_field})", "{$value_table}_{$value_field}", array(
            'aggregate' => TRUE,
          ));
          break;
        default:
          $field_alias = $this->query
            ->add_field($value_table, $value_field);
          break;
      }
    }
    $this->value_table = $alias;
    $this->value_field = $field_alias;
    $this->query
      ->set_count_field($alias, $value_field, $field_alias);
  }

  /**
   * Return an array usable as a plot point by flot.
   */
  function flot_render($values) {
    if ($this->use_date) {
      $series = $values->{$this->series_field};
      $series_label = format_date($values->{$this->series_field}, $this->options['series']['date_format']);
    }
    else {
      $series_label = $series = check_plain($values->{$this->series_field});
    }
    $value = check_plain($values->{$this->value_field});
    return array(
      'value' => array(
        $series,
        $value,
      ),
      'label' => array(
        $series_label,
        $value,
      ),
    );
  }

  /**
   * Optional method that allows the data source to determine axis bounds.
   */
  function pre_render($result) {
    if ($this->use_date) {

      // First grab endpoints from any date filters
      $filters = $this->view->display_handler
        ->get_handlers('filter');
      foreach ($filters as $filter => $handler) {
        if (strpos(get_class($handler), '_date') !== FALSE) {
          $min = $handler->value['min'];
          $min = !is_numeric($min) ? time() + intval(strtotime($min, 0)) : $min;
          $max = $handler->value['max'];
          $max = !is_numeric($max) ? time() + intval(strtotime($max, 0)) : $max;
          $value = intval(strtotime($handler->value['value'], 0));
          switch ($handler->operator) {
            case 'between':
              $start = $min;
              $end = $max;
              break;
            case '>=':
            case '>':
              $start = $min;

              // We can't count on sort order of the result set but do
              // assume that things have been sorted.
              $front = reset($result)->{$this->series_field};
              $front = !is_numeric($front) ? strtotime($front) : $front;
              $back = end($result)->{$this->series_field};
              $back = !is_numeric($back) ? strtotime($back) : $back;
              $end = $front > $back ? $front : $back;
              break;
            case '<=':
            case '<':
              $front = reset($result)->{$this->series_field};
              $front = !is_numeric($front) ? strtotime($front) : $front;
              $back = end($result)->{$this->series_field};
              $back = !is_numeric($back) ? strtotime($back) : $back;
              $start = $front < $back ? $front : $back;
              $end = $max;
              break;
          }
          break;
        }
      }
      $units = array(
        'Y-m-d-H' => '+1 hour',
        'Y-m-d-3' => '+3 hours',
        'Y-m-d-6' => '+6 hours',
        'Y-m-d-A' => '+12 hours',
        'Y-m-d' => '+1 day',
        'Y-m' => '+1 month',
        'Y' => '+1 year',
      );
      $grouping = $this->options['series']['grouping'];
      $grouping = isset($units[$grouping]) ? $grouping : 'Y-m-d';

      // Fill in default values in processed array.
      $processed = array();
      while ($start < $end) {
        $start = strtotime($units[$grouping], $start);
        $start_formatted = $this
          ->format_date($start, $grouping);
        $blank = new stdClass();
        $blank->{$this->series_field} = $start;
        $blank->{$this->value_field} = 0;
        $processed[$start_formatted] = $blank;
      }
      foreach ($result as $row) {
        $timestamp_formatted = $this
          ->format_date($row->{$this->series_field}, $grouping);
        if (isset($processed[$timestamp_formatted])) {
          $processed[$timestamp_formatted]->{$this->value_field}++;
        }
      }
      $this->view->result = array_values($processed);
    }
  }

  /**
   * Custom date formatter for achieving date granularity between 1 hour and 12 hours (AM/PM).
   */
  function format_date($timestamp, $format) {
    switch ($format) {
      case 'Y-m-d-3':
      case 'Y-m-d-6':
        $base = strtotime(format_date($timestamp, 'custom', 'Y-m-d'));
        $hour = format_date($timestamp, 'custom', 'H');
        $hours = array(
          'Y-m-d-3' => array(
            3,
            6,
            9,
            12,
            15,
            18,
            21,
            24,
          ),
          'Y-m-d-6' => array(
            6,
            12,
            18,
            24,
          ),
        );
        foreach ($hours[$format] as $slot) {
          if ($hour < $slot) {
            $formatted = strtotime("+{$slot} hours", $base);
            break;
          }
        }
        return format_date($formatted, 'custom', 'Y-m-d-H');
      default:
        return format_date($timestamp, 'custom', $format);
    }
  }

  /**
   * The default render function.
   */
  function render($values) {
    $series = check_plain($values->{$this->series_field});
    $value = check_plain($values->{$this->value_field});
    return "{$series}, {$value}";
  }

}

Members

Name	Modifiers	Type	Description	Overrides
flot_handler_field_datapoint::$use_date	protected	property
flot_handler_field_datapoint::allow_advanced_render		function	Disable advanced render.
flot_handler_field_datapoint::flot_render		function	Return an array usable as a plot point by flot.
flot_handler_field_datapoint::format_date		function	Custom date formatter for achieving date granularity between 1 hour and 12 hours (AM/PM).
flot_handler_field_datapoint::options_form		function	Options form.
flot_handler_field_datapoint::option_definition		function	Option defaults.
flot_handler_field_datapoint::pre_render		function	Optional method that allows the data source to determine axis bounds.
flot_handler_field_datapoint::query		function	Query method.
flot_handler_field_datapoint::render		function	The default render function.