You are here

Home » API reference » Views Charts 7 » views_plugin_style_chart.inc

class views_plugin_style_chart in Views Charts 7

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

Hierarchy

Expanded class hierarchy of views_plugin_style_chart

1 string reference to 'views_plugin_style_chart'
views_charts_views_plugins in ./views_charts.views.inc
@todo Please document this function.

File

./views_plugin_style_chart.inc, line 17
Holds views_plugin_style_chart class which implements the chart plugin.

View source 
class views_plugin_style_chart extends views_plugin_style {

  /**
   * Set default options.
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['width'] = array(
      'default' => '500',
    );
    $options['height'] = array(
      'default' => '600',
    );
    $options['type'] = array(
      'default' => array(
        'bluff' => 'line',
      ),
    );
    $options['showlegend'] = TRUE;
    $options['zoom'] = FALSE;
    $options['views_charts_series_fields'] = array(
      'default' => array(),
    );
    $options['views_charts_x_labels'] = array(
      'default' => '',
    );
    $options['engine'] = array(
      'default' => 'bluff',
    );
    $options['y_min'] = array(
      'default' => '0',
    );
    $options['y_max'] = array(
      'default' => '100',
    );
    $options['y_step'] = array(
      'default' => '25',
    );
    $options['y_legend'] = array(
      'default' => FALSE,
    );
    $options['background_colour'] = array(
      'default' => '#FFFFFF',
    );
    $options['series_colours'] = array(
      'default' => array(),
    );
    return $options;
  }

  /**
   * Options form.
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $curr_disp = $this->view->current_display;
    $views_fields = $this
      ->_get_fields();
    $def_val_series = $this->options['views_charts_series_fields'];
    $def_val_series = empty($def_val_series) || !is_array($def_val_series) ? array(
      t('-- None --'),
    ) : $def_val_series;
    $form['views_charts_series_fields'] = array(
      '#title' => t('Fields to be used in Chart Series'),
      '#type' => 'select',
      '#options' => $views_fields,
      '#multiple' => TRUE,
      '#required' => TRUE,
      '#description' => t('These fields will be used as data fields for chart series. Fields must contain numeric data!'),
      '#default_value' => $def_val_series,
    );
    $views_fields = $this
      ->_get_fields();
    $def_val_labels = $this->options['views_charts_x_labels'];
    $def_val_labels = empty($def_val_labels) ? array(
      t('-- None --'),
    ) : $def_val_labels;
    $form['views_charts_x_labels'] = array(
      '#title' => t('Fields to be used as X axis labels'),
      '#type' => 'select',
      '#options' => $views_fields,
      '#multiple' => FALSE,
      '#required' => TRUE,
      '#default_value' => $def_val_labels,
    );
    $form['width'] = array(
      '#type' => 'textfield',
      '#title' => t('Canvas width'),
      '#description' => t('Canvas width, for libraries that support it you can supply a percentage, otherwise, provide a number for pixels. Defaults to 600px when input is invalid.'),
      '#default_value' => $this->options['width'],
    );
    $form['height'] = array(
      '#type' => 'textfield',
      '#title' => t('Canvas height'),
      '#description' => t('Canvas height in pixels only.  Defaults to 500px when input is invalid.'),
      '#default_value' => $this->options['height'],
    );
    $engines = array();
    $types = array();
    $api_names = array();
    foreach ($apis = $this
      ->charts_graphs_apis() as $api) {
      $engines[$api->name] = $api->nice_name;
      $types[$api->name] = $api->chart_types;
      $api_names[] = $api->name;
    }
    sort($api_names);
    $form['engine'] = array(
      '#type' => 'select',
      '#title' => t('Charting Engine'),
      '#options' => $engines,
      '#default_value' => $this->options['engine'],
    );
    $current_engine = empty($this->options['engine']) ? $api_names[0] : $this->options['engine'];
    foreach ($types as $engine => $type) {
      $default = !empty($this->options['type'][$engine]) ? $this->options['type'][$engine] : array_shift(array_keys($type));
      $hidden = NULL;
      if ($engine != $current_engine) {
        $hidden = 'views_charts_chart_types_hidden';
      }
      $form['type'][$engine] = array(
        '#type' => 'radios',
        '#title' => t('Chart Type'),
        '#options' => $type,
        '#required' => TRUE,
        '#default_value' => $default,
        '#prefix' => sprintf('<div class="views_charts_chart_types views_charts_%s_chart_types %s">', $engine, $hidden),
        '#suffix' => '</div>',
      );
    }
    $form['y_min'] = array(
      '#type' => 'textfield',
      '#title' => t('Minimun value of Y Axis'),
      '#default_value' => $this->options['y_min'] ? $this->options['y_min'] : '',
    );
    $form['y_max'] = array(
      '#type' => 'textfield',
      '#title' => t('Maximun value of Y Axis'),
      '#default_value' => $this->options['y_max'] ? $this->options['y_max'] : '',
    );
    $form['y_step'] = array(
      '#type' => 'textfield',
      '#title' => t('Step value of Y Axis'),
      '#default_value' => $this->options['y_step'] ? $this->options['y_step'] : '',
    );
    $form['y_legend'] = array(
      '#type' => 'textfield',
      '#title' => t('Y Legend'),
      '#default_value' => $this->options['y_legend'],
    );
    $form['background_colour'] = array(
      '#type' => 'textfield',
      '#title' => t('Graph background colour'),
      '#description' => t('Define the colour in hexadecimal: #RRGGBB'),
      '#default_value' => $this->options['background_colour'],
    );
    $form['series_colours'] = array(
      '#type' => 'textfield',
      '#title' => t('Series colours'),
      '#description' => t('Define the colour of each series as a comma separated list of hexadecimal colour definitions. Ex: #123456,#654321,#1177ff'),
      '#default_value' => $this->options['series_colours'],
    );
    $form['showlegend'] = array(
      '#type' => 'checkbox',
      '#title' => t('Show Legend'),
      '#description' => t('Show or hide the legend, if the library supports it.'),
      '#default_value' => $this->options['showlegend'],
    );
    $form['zoom'] = array(
      '#type' => 'checkbox',
      '#title' => t('Zoom'),
      '#description' => t('Flot only! Adds a second smaller version of the graps that allows you to zoom in and out.'),
      '#default_value' => $this->options['zoom'],
    );
  }

  /**
   * Render the display in this style.
   */
  function render() {

    // Group the rows according to the grouping field, if specified.
    $sets = $this
      ->render_grouping($this->view->result, $this->options['grouping']);
    $output = '';
    foreach ($sets as $title => $rows) {
      $output .= $this
        ->_render($rows, $title);
    }
    unset($this->view->row_index);
    return $output;
  }
  function _render($rows, $title) {
    if (!isset($this->options['engine'])) {
      drupal_set_message("No engine specified for display '" . $this->view->current_display . "' on view '" . $this->view->name . "'");
      return FALSE;
    }
    if ($canvas = $this
      ->charts_graphs_get_graph($this->options['engine'])) {
      $cgp_data = $this
        ->_transform_data($rows);
      $canvas
        ->set_data($cgp_data->rows, $cgp_data->x_labels);
      $canvas->x_type = $cgp_data->x_type;
      $curr_disp = $this->view->current_display;
      $canvas->title = $this->view->display[$curr_disp]->handler
        ->get_option('title');
      $canvas->type = $this->options['type'][$this->options['engine']];
      $canvas->y_legend = $this->options['y_legend'];
      if (isset($this->options['y_min']) && !empty($this->options['y_min'])) {
        $canvas->y_min = $this->options['y_min'];
      }
      if (isset($this->options['y_max']) && !empty($this->options['y_max'])) {
        $canvas->y_max = $this->options['y_max'];
      }
      if (isset($this->options['y_step']) && !empty($this->options['y_step'])) {
        $canvas->y_step = $this->options['y_step'];
      }
      if (isset($this->options['background_colour'])) {
        $background_colour = trim($this->options['background_colour']);
        if (!empty($background_colour)) {
          $canvas->colour = $background_colour;
        }
      }
      if (!empty($this->options['series_colours'])) {
        $series_colours = explode(',', $this->options['series_colours']);
        if (count($series_colours)) {
          $canvas->series_colours = $series_colours;
        }
      }
      else {
        $canvas->series_colours = $canvas
          ->series_colours();
      }

      // make the user input a bit more resilient;
      $width = str_replace("px", "", $this->options['width']);

      // just for people who are confused and still added this
      $width = is_numeric($width) || is_numeric(str_replace("%", "", $width)) ? $width : "600";
      $height = str_replace("px", "", $this->options['height']);
      $height = is_numeric($height) ? $height : "500";
      $canvas->width = $width;
      $canvas->height = $height;
      $canvas->showlegend = $this->options['showlegend'];
      $canvas->zoom = $this->options['zoom'];

      // Flot only

      //'admin/structure/views' - issues with javascript etc. Do not try to render
      if (arg(0) == 'admin' && arg(1) == 'build' && arg(2) == 'views') {
        $msg = t("Preview not available for Charts display style. Please view on a full page");
        $msg = "<div class=\"messages error\"><b>{$msg}</b></div>";
        return $msg;
      }
      views_charts_invoke_all('views_charts_graph_alter', array(
        &$canvas,
      ));
      $element = $canvas
        ->get_chart();
      return render($element);
    }
    else {
      drupal_set_message("Graph with engine " . $this->options['engine'] . " not available");
    }
  }

  /**
   * Transform data from Views-centric representation into standard Charts and
   * Graphs input format.
   *
   * @return <stdClass>
   */
  function _transform_data($db_rows) {
    $series_column_names = $this->options['views_charts_series_fields'];
    $x_label_column = $this->options['views_charts_x_labels'];
    $x_isnum = FALSE;
    $x_isdate = FALSE;
    $views_fields = $this->view->field;
    $fields_x_names = array();
    $series_full_names = $this
      ->_get_fields(TRUE);
    $x_label_alias_found = FALSE;
    $aliases = array();
    foreach ($views_fields as $idx => $f) {
      $db_alias = $idx;

      //$f->real_field;
      if (in_array($idx, $this->options['views_charts_series_fields'])) {
        $fields_x_names[$idx] = $series_full_names[$idx];
      }
      $aliases[$idx] = $idx;
      if (trim($x_label_column) == trim($idx) && $x_label_alias_found == FALSE) {
        $x_label_column = $idx;
        $x_isdate = get_class($views_fields[$idx]) == 'views_handler_field_date' && $views_fields[$idx]->options['date_format'] == 'custom' && $views_fields[$idx]->options['custom_date_format'] == 'U' || get_class($views_fields[$idx]) == 'views_handler_field_field' && $views_fields[$idx]->field_info['type'] == 'date' && date_format_type_format($views_fields[$idx]->options['settings']['format_type']) == 'U';
        $x_isnum = isset($views_fields[$idx]->field_info) && $views_fields[$idx]->field_info['module'] == 'number';
        $x_label_alias_found = TRUE;
      }
    }

    // We need to re-map the db results array so that labels are indexes.
    $rows = array();
    $labels = array();
    foreach ($db_rows as $rowid => $row) {
      $cols = (array) $row;
      if (isset($x_label_column)) {
        if (!$x_isnum) {
          $labels[] = strip_tags($this->rendered_fields[$rowid][$x_label_column]);
        }
        else {
          $labels[] = $views_fields[$aliases[$x_label_column]]->original_value;

          // no rendering for numbers
        }
        foreach ($fields_x_names as $key => $label) {
          $rows[$label][] = (double) $this->view->field[$key]
            ->theme($row);
        }
      }
      else {
        $labels[] = t('unknown');
      }
    }
    $ret = new stdClass();
    $ret->rows = $rows;
    $ret->x_labels = $labels;
    if ($x_isdate) {
      $ret->x_type = 'date';
    }
    elseif ($x_isnum) {
      $ret->x_type = 'number';
    }
    else {
      $ret->x_type = 'text';
    }
    return $ret;
  }

  /**
   *
   * @param <type> $return_pretty_name Return only the label, so we can use it
   * on chart.
   * @return <type>
   */
  function _get_fields($return_pretty_name = FALSE) {
    $handlers = $this->display->handler
      ->get_handlers('field');
    $avail_fields = array();
    if (is_array($handlers)) {
      foreach ($handlers as $field => $handler) {
        $field_alias = $handler->options['table'] . '_' . $handler->options['field'];
        $relationship = '';
        $all_relationships = $this
          ->_get_relationships();
        $rel = $handler->options['relationship'];
        $rel = isset($all_relationships[$rel]) ? $all_relationships[$rel] : NULL;
        if (!empty($rel)) {

          //          $field_name = $rel->fieldprefix . '.' . $val->options['field']; // reserved, not used
          //          $field_alias = $rel->fieldprefix . '_' . $val->options['field'];
          $relationship = empty($rel) ? '' : '[' . $rel->label . '] ';
        }
        $label = $handler
          ->label() ? $handler
          ->label() : $handler
          ->ui_name();
        $field_name = $relationship . $handler->definition['group'] . ': ' . $handler->definition['title'] . ' (' . $label . ')';
        $avail_fields[$field] = $return_pretty_name ? $label : $field_name;
      }
    }
    return $avail_fields;
  }
  function _get_relationships() {
    $default_rels = array();
    $curr_disp_rels = array();
    $curr_disp = $this->view->current_display;
    $default_rels = $this->view->display['default']->handler->options['relationships'];
    $curr_displ_rels = isset($this->view->display[$curr_disp]->handler->options['relationships']) ? $this->view->display[$curr_disp]->handler->options['relationships'] : NULL;
    $default_rels = is_array($default_rels) ? $default_rels : array();
    $curr_displ_rels = is_array($curr_displ_rels) ? $curr_displ_rels : array();
    $relationships = array_merge($default_rels, $curr_displ_rels);
    $all_rels = array();
    $base_table = $this->view->base_table;
    if (is_array($relationships)) {
      foreach ($relationships as $key => $val) {
        $obj = new stdClass();
        $obj->fieldprefix = $base_table . '_' . $val['table'];
        $obj->label = $val['label'];
        $obj->table = $val['table'];
        $obj->field = $val['field'];
        $all_rels[$key] = $obj;
      }
    }
    return $all_rels;
  }
  function charts_graphs_apis($library = NULL) {
    $function = function_exists('chart_graphs_apis') ? 'chart_graphs_apis' : 'charts_graphs_apis';
    if ($library === NULL) {
      return call_user_func($function);
    }
    else {
      return call_user_func($function, $library);
    }
  }
  function charts_graphs_get_graph($library) {
    $function = function_exists('chart_graphs_get_graph') ? 'chart_graphs_get_graph' : 'charts_graphs_get_graph';
    if (function_exists($function)) {
      return call_user_func($function, $library);
    }
    else {
      return FALSE;
    }
  }

}

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_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::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_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::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
views_plugin_style_chart::charts_graphs_apis function
views_plugin_style_chart::charts_graphs_get_graph function
views_plugin_style_chart::options_form function Options form. Overrides views_plugin_style::options_form
views_plugin_style_chart::option_definition function Set default options. Overrides views_plugin_style::option_definition
views_plugin_style_chart::render function Render the display in this style. Overrides views_plugin_style::render
views_plugin_style_chart::_get_fields function
views_plugin_style_chart::_get_relationships function
views_plugin_style_chart::_render function
views_plugin_style_chart::_transform_data function Transform data from Views-centric representation into standard Charts and Graphs input format.