You are here

Home » API reference » Flot 7 » flot_handler_field_datapoint.inc

class flot_handler_field_datapoint in Flot 7

Same name and namespace in other branches
  1. 6 views/flot_handler_field_datapoint.inc \flot_handler_field_datapoint

Hierarchy

Expanded class hierarchy of flot_handler_field_datapoint

1 string reference to 'flot_handler_field_datapoint'
flot_views_views_data_alter in flot_views/views/flot_views.views.inc
Implements hook_views_data_alter().

File

flot_views/views/flot_handler_field_datapoint.inc, line 4

View source 
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'),
            ),
            '#dependency' => array(),
            '#default_value' => $this->options['series']['grouping'],
          );
          $form['series']['date_format'] = array(
            '#title' => t('Date format'),
            '#type' => 'select',
            '#options' => array(
              'short' => format_date(REQUEST_TIME, 'short'),
              'medium' => format_date(REQUEST_TIME, 'medium'),
              'long' => format_date(REQUEST_TIME, 'long'),
            ),
            '#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 = REQUEST_TIME + intval(strtotime($handler->value['min'], 0));
          $max = REQUEST_TIME + intval(strtotime($handler->value['max'], 0));
          $value = intval(strtotime($handler->value['value'], 0));
          switch ($handler->operator) {
            case 'between':
              $start = $min;
              $end = $max;
              break;
            case '>=':
            case '>':
              $start = $min;
              $end = strtotime(end($result)->{$this->series_field});
              break;
            case '<=':
            case '<':
              $start = strtotime($result[0]->{$this->series_field});
              $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])) {
          if ($this->options['value']['format'] == "raw") {
            $processed[$timestamp_formatted]->values[] = $row->{$this->value_field};
          }
          elseif ($this->options['value']['format'] == "count") {
            $processed[$timestamp_formatted]->{$this->value_field}++;
          }
        }
      }

      // Average out the values.
      if ($this->options['value']['format'] == "raw") {
        foreach ($processed as &$item) {
          $values = isset($item->values) ? $item->values : array();
          if (count($values)) {
            $item->{$this->value_field} = array_sum($values) / count($values);
          }
        }
      }
      $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

Namesort descending Modifiers Type Description Overrides
flot_handler_field_datapoint::$use_date protected property
flot_handler_field_datapoint::allow_advanced_render function Disable advanced render. Overrides views_handler_field::allow_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. Overrides views_handler_field::options_form
flot_handler_field_datapoint::option_definition function Option defaults. Overrides views_handler_field::option_definition
flot_handler_field_datapoint::pre_render function Optional method that allows the data source to determine axis bounds. Overrides views_handler_field::pre_render
flot_handler_field_datapoint::query function Query method. Overrides views_handler_field::query
flot_handler_field_datapoint::render function The default render function. Overrides views_handler_field::render
views_handler::$handler_type public property The type of the handler, for example filter/footer/field.
views_handler::$query public property Where the $query object will reside:. 1
views_handler::$real_field public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
views_handler::$relationship public property The relationship used for this field.
views_handler::$table_alias public property The alias of the table of this handler which is used in the query.
views_handler::$view public property The top object of a view. Overrides views_object::$view
views_handler::accept_exposed_input public function Take input from exposed handlers and assign to this handler, if necessary. 1
views_handler::access public function Check whether current user has access to this handler. 10
views_handler::broken public function Determine if the handler is considered 'broken'. 6
views_handler::can_expose public function Determine if a handler can be exposed. 2
views_handler::case_transform public function Transform a string by a certain method.
views_handler::ensure_my_table public function Ensure the main table for this handler is in the query. This is used a lot. 8
views_handler::exposed_form public function Render our chunk of the exposed handler form when selecting. 1
views_handler::exposed_info public function Get information about the exposed form for the form renderer. 1
views_handler::exposed_submit public function Submit the exposed handler form.
views_handler::exposed_validate public function Validate the exposed handler form. 4
views_handler::expose_form public function Form for exposed handler options. 2
views_handler::expose_options public function Set new exposed option defaults when exposed setting is flipped on. 2
views_handler::expose_submit public function Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data.
views_handler::expose_validate public function Validate the options form. 1
views_handler::extra_options public function Provide defaults for the handler.
views_handler::extra_options_form public function Provide a form for setting options. 1
views_handler::extra_options_submit public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
views_handler::extra_options_validate public function Validate the options form.
views_handler::get_field public function Shortcut to get a handler's raw field value.
views_handler::get_join public function Get the join object that should be used for this handler.
views_handler::groupby_form public function Provide a form for aggregation settings. 1
views_handler::groupby_form_submit public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. 1
views_handler::has_extra_options public function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. 1
views_handler::is_a_group public function Returns TRUE if the exposed filter works like a grouped filter. 1
views_handler::is_exposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::multiple_exposed_input public function Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. 1
views_handler::needs_style_plugin public function Determine if the argument needs a style plugin. 1
views_handler::options_validate public function Validate the options form. 4
views_handler::placeholder public function Provides a unique placeholders for handlers.
views_handler::post_execute public function Run after the view is executed, before the result is cached. 1
views_handler::pre_query public function Run before the view is built. 1
views_handler::sanitize_value public function Sanitize the value for output.
views_handler::set_relationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::show_expose_button public function Shortcut to display the expose/hide button. 2
views_handler::show_expose_form public function Shortcut to display the exposed options form.
views_handler::store_exposed_input public function If set to remember exposed input in the session, store it there. 1
views_handler::use_group_by public function Provides the handler some groupby. 2
views_handler::validate public function Validates the handler against the complete View. 1
views_handler_field::$additional_fields public property Stores additional fields which get added to the query. The generated aliases are stored in $aliases.
views_handler_field::$aliases public property
views_handler_field::$field_alias public property
views_handler_field::$last_render_index protected property Keeps track of the last render index.
views_handler_field::$original_value public property The field value prior to any rewriting.
views_handler_field::add_additional_fields public function Add 'additional' fields to the query.
views_handler_field::add_self_tokens public function Add any special tokens this field might use for itself. 4
views_handler_field::admin_summary public function Provide extra data to the administration form Overrides views_handler::admin_summary
views_handler_field::advanced_render public function Render a field using advanced settings.
views_handler_field::click_sort public function Called to determine what to tell the clicksorter. 1
views_handler_field::click_sortable public function Determine if this field is click sortable. 1
views_handler_field::construct public function Construct a new field handler. Overrides views_object::construct 17
views_handler_field::document_self_tokens public function Document any special tokens this field might use for itself. 4
views_handler_field::element_classes public function Return the class of the field.
views_handler_field::element_label_classes public function Return the class of the field's label.
views_handler_field::element_label_type public function Return an HTML element for the label based upon the field's element type.
views_handler_field::element_type public function Return an HTML element based upon the field's element type. 2
views_handler_field::element_wrapper_classes public function Return the class of the field's wrapper.
views_handler_field::element_wrapper_type public function Return an HTML element for the wrapper based upon the field's element type.
views_handler_field::get_elements public function Provide a list of elements valid for field HTML.
views_handler_field::get_render_tokens public function Get the 'render' tokens to use for advanced rendering.
views_handler_field::get_token_values_recursive public function Recursive function to add replacements for nested query string parameters.
views_handler_field::get_value public function Get the value that's supposed to be rendered. 3
views_handler_field::init public function Init the handler with necessary data. Overrides views_handler::init 11
views_handler_field::is_value_empty public function Checks if a field value is empty.
views_handler_field::label public function Get this field's label.
views_handler_field::options_submit public function Performs some cleanup tasks on the options array before saving it. Overrides views_handler::options_submit 1
views_handler_field::render_altered public function Render this field as altered text, from a fieldset set by the user.
views_handler_field::render_as_link public function Render this field as a link, with info from a fieldset set by the user.
views_handler_field::render_text public function Perform an advanced text render for the item.
views_handler_field::render_trim_text public function Trim the field down to the specified length.
views_handler_field::theme public function Call out to the theme() function.
views_handler_field::theme_functions public function Build a list of suitable theme functions for this view.
views_handler_field::tokenize_value public function Replace a value with tokens from the last field.
views_handler_field::ui_name public function Return a string representing this handler's name in the UI. Overrides views_handler::ui_name 1
views_handler_field::use_string_group_by public function Determines if this field will be available as an option to group the result by in the style settings.
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::destroy public function Destructor. 2
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