class charts_plugin_style_chart in Charts 7.2

Same name and namespace in other branches

6 views/charts_plugin_style_chart.inc \charts_plugin_style_chart
7 views/charts_plugin_style_chart.inc \charts_plugin_style_chart

Style plugin to render view as a chart.

Hierarchy

class \views_object
- class \views_plugin
  - class \views_plugin_style
    class \charts_plugin_style_chart

Expanded class hierarchy of charts_plugin_style_chart

1 string reference to 'charts_plugin_style_chart'

charts_views_plugins in views/charts.views.inc: Implementation of hook_views_plugins().

File

views/charts_plugin_style_chart.inc, line 12: Contains the Chart style (format) plugin (similar to Table, HTML List, etc.)

View source

class charts_plugin_style_chart extends views_plugin_style {

  /**
   * Set default options.
   */
  function option_definition() {
    $options = parent::option_definition();

    // Get the default chart values
    module_load_include('inc', 'charts', 'includes/charts.pages');
    $defaults = variable_get('charts_default_settings', array());
    $defaults += charts_default_settings();
    foreach ($defaults as $default_key => $default_value) {
      $options[$default_key]['default'] = $default_value;
    }

    // Remove the default setting for chart type so it can be inherited if this
    // is a chart extension type.
    if ($this->plugin_name === 'chart_extension') {
      $options['type']['default'] = NULL;
    }
    return $options;
  }

  /**
   * Generate a form for setting options.
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $handlers = $this->display->handler
      ->get_handlers('field');
    if (empty($handlers)) {
      $form['error_markup'] = array(
        '#markup' => '<div class="error messages">' . t('You need at least one field before you can configure your table settings') . '</div>',
      );
      return;
    }

    // Limit grouping options (we only support one grouping field).
    if (isset($form['grouping'][0])) {
      $form['grouping'][0]['field']['#title'] = t('Grouping field');
      $form['grouping'][0]['field']['#description'] = t('If grouping by a particular field, that field will be used to generate multiple data series on the same chart.');
      $form['grouping'][0]['field']['#attributes']['class'][] = 'charts-grouping-field';

      // Grouping by rendered version has no effect in charts. Hide the options.
      $form['grouping'][0]['rendered']['#access'] = FALSE;
      $form['grouping'][0]['rendered_strip']['#access'] = FALSE;
    }
    if (isset($form['grouping'][1])) {
      $form['grouping'][1]['#access'] = FALSE;
    }

    // Merge in the global chart settings form.
    module_load_include('inc', 'charts', 'includes/charts.pages');
    $field_options = $this->display->handler
      ->get_field_labels();
    $form = charts_settings_form($form, $this->options, $field_options, array(
      'style_options',
    ));

    // Reduce the options if this is a chart extension.
    if ($parent_display = $this
      ->get_parent_chart_display()) {
      $parent_chart_type = chart_get_type($parent_display->display_options['style_options']['type']);
      if (empty($form['type']['#default_value'])) {
        $form['type']['#default_value'] = $parent_display->display_options['style_options']['type'];
      }
      $form['type']['#description'] = empty($form['type']['#description']) ? '' : $form['type']['#description'] . ' ';
      $form['type']['#description'] .= t('This chart will be combined with the parent display "@display_title", which is a "@type" chart. Not all chart types may be combined. Selecting a different chart type than the parent may cause errors.', array(
        '@display_title' => $parent_display->display_title,
        '@type' => $parent_chart_type['label'],
      ));
      $form['fields']['label_field']['#disabled'] = TRUE;
      $form['display']['#access'] = FALSE;
      $form['xaxis']['#access'] = FALSE;
      if ($this->display->handler
        ->get_option('inherit_yaxis')) {
        $form['yaxis']['#access'] = FALSE;
      }
      else {
        $form['yaxis']['#title'] = t('Secondary axis');
        $form['yaxis']['#attributes']['class'] = array();
      }
    }
  }

  /**
   * Generate a form for setting options.
   */
  function options_submit(&$form, &$form_state) {
    parent::options_submit($form, $form_state);
  }

  /**
   * Make sure the display and all associated handlers are valid.
   *
   * @return
   *   Empty array if the display is valid; an array of error strings if it is not.
   */
  function validate() {
    $errors = array();
    $field_handlers = $this->display->handler
      ->get_handlers('field');

    // Don't execute validation on the new view page.
    if ($_GET['q'] === 'admin/structure/views/add') {
      return;
    }

    // Make sure that all chart extensions first have a parent chart selected.
    if ($this->plugin_name === 'chart_extension' && $this
      ->get_parent_chart_display() === FALSE) {
      $errors[] = t('This chart add-on must have a parent chart selected under the chart settings.');
    }
    elseif (count($field_handlers)) {
      $data_field_key = !empty($this->options['data_fields']) ? current($this->options['data_fields']) : NULL;
      if (empty($data_field_key)) {
        $errors[] = t('At least one data field must be selected in the chart configuration before this chart may be shown');
      }
      else {
        $data_field = isset($field_handlers[$data_field_key]) ? $field_handlers[$data_field_key] : NULL;
        if (!isset($data_field)) {
          $errors[] = t('A field you have specified as a data field in your chart settings no longer exists. Edit the chart settings and select at least one data field.');
        }
      }
    }
    return $errors;
  }

  /**
   * Render the entire view from the view result.
   */
  function render() {
    $field_handlers = $this->display->handler
      ->get_handlers('field');

    // Calculate the labels field alias.
    $label_field = FALSE;
    $label_field_key = NULL;
    if ($this->options['label_field'] && array_key_exists($this->options['label_field'], $field_handlers)) {
      $label_field = $field_handlers[$this->options['label_field']];
      $label_field_key = $this->options['label_field'];
    }

    // Assemble the fields to be used to provide data access.
    $data_field_options = array_filter($this->options['data_fields']);
    $data_fields = array();
    foreach ($data_field_options as $field_key) {
      if (isset($field_handlers[$field_key])) {
        $data_fields[$field_key] = $field_handlers[$field_key];
      }
    }

    // Do not allow the label field to be used as a data field.
    if (isset($data_fields[$label_field_key])) {
      unset($data_fields[$label_field_key]);
    }
    $chart_id = $this->view->name . '__' . $this->view->current_display;
    $chart = array(
      '#type' => 'chart',
      '#chart_type' => $this->options['type'],
      '#chart_library' => $this->options['library'],
      '#chart_id' => $chart_id,
      '#id' => drupal_clean_css_identifier('chart_' . $chart_id),
      '#title' => $this->options['title_position'] ? $this->options['title'] : FALSE,
      '#title_position' => $this->options['title_position'],
      '#tooltips' => $this->options['tooltips'],
      '#data_labels' => $this->options['data_labels'],
      '#colors' => $this->options['type'] != 'geomap' ? $this->options['colors'] : FALSE,
      '#background' => $this->options['background'] ? $this->options['background'] : 'transparent',
      '#legend' => $this->options['legend_position'] ? TRUE : FALSE,
      '#legend_position' => $this->options['legend_position'] ? $this->options['legend_position'] : NULL,
      '#width' => $this->options['width'],
      '#height' => $this->options['height'],
      '#view' => $this->view,
    );
    $chart_type_info = chart_get_type($this->options['type']);
    if ($chart_type_info['axis'] === CHARTS_SINGLE_AXIS) {
      $data_field_key = key($data_fields);
      $data_field = $data_fields[$data_field_key];
      $data = array();
      $renders = $this
        ->render_fields($this->view->result);
      foreach ($renders as $row_number => $row) {
        $data_row = array();
        if ($label_field_key) {

          // Labels need to be decoded, as the charting library will re-encode.
          $data_row[] = htmlspecialchars_decode($this
            ->get_field($row_number, $label_field_key), ENT_QUOTES);
        }
        $value = $this
          ->get_field($row_number, $data_field_key);

        // Convert empty strings to NULL.
        if ($value === '') {
          $value = NULL;
        }
        else {
          $value = (double) str_replace(array(
            ',',
            ' ',
          ), '', $value);
        }
        $data_row[] = $value;
        $data[] = $data_row;
      }
      if ($label_field) {
        $chart['#legend_title'] = $label_field->options['label'];
      }
      $chart[$this->view->current_display . '_series'] = array(
        '#type' => 'chart_data',
        '#data' => $data,
        '#title' => $data_field->options['label'],
      );
    }
    else {
      $chart['xaxis'] = array(
        '#type' => 'chart_xaxis',
        '#title' => $this->options['xaxis_title'] ? $this->options['xaxis_title'] : FALSE,
        '#labels_rotation' => $this->options['xaxis_labels_rotation'],
      );
      $chart['yaxis'] = array(
        '#type' => 'chart_yaxis',
        '#title' => $this->options['yaxis_title'] ? $this->options['yaxis_title'] : FALSE,
        '#labels_rotation' => $this->options['yaxis_labels_rotation'],
        '#max' => $this->options['yaxis_max'],
        '#min' => $this->options['yaxis_min'],
      );
      $sets = $this
        ->render_grouping($this->view->result, $this->options['grouping'], TRUE);
      foreach ($sets as $series_label => $data_set) {
        $series_index = isset($series_index) ? $series_index + 1 : 0;
        foreach ($data_fields as $field_key => $field_handler) {
          $chart[$this->view->current_display . '__' . $field_key . '_' . $series_index] = array(
            '#type' => 'chart_data',
            '#data' => array(),
            // If using a grouping field, inherit from the chart level colors.
            '#color' => $series_label === '' && isset($this->options['field_colors'][$field_key]) ? $this->options['field_colors'][$field_key] : NULL,
            '#title' => $series_label ? $series_label : $field_handler->options['label'],
            '#prefix' => $this->options['yaxis_prefix'] ? $this->options['yaxis_prefix'] : NULL,
            '#suffix' => $this->options['yaxis_suffix'] ? $this->options['yaxis_suffix'] : NULL,
            '#decimal_count' => $this->options['yaxis_decimal_count'] ? $this->options['yaxis_decimal_count'] : NULL,
          );
        }

        // Grouped results come back indexed by their original result number
        // from before the grouping, so we need to keep our own row number when
        // looping through the rows.
        $row_number = 0;
        foreach ($data_set['rows'] as $result_number => $row) {
          if ($label_field_key && !isset($chart['xaxis']['#labels'][$row_number])) {
            $chart['xaxis']['#labels'][$row_number] = $this
              ->get_field($result_number, $label_field_key);
          }
          foreach ($data_fields as $field_key => $field_handler) {

            // Don't allow the grouping field to provide data.
            if (isset($this->options['grouping'][0]['field']) && $field_key === $this->options['grouping'][0]['field']) {
              continue;
            }
            $value = $this
              ->get_field($result_number, $field_key);

            // Convert empty strings to NULL.
            if ($value === '') {
              $value = NULL;
            }
            else {
              $value = (double) str_replace(array(
                ',',
                ' ',
              ), '', $value);
            }
            $chart[$this->view->current_display . '__' . $field_key . '_' . $series_index]['#data'][] = $value;
          }
          $row_number++;
        }
      }
    }

    // Check if this display has any children charts that should be applied
    // on top of it.
    $parent_display_id = $this->view->current_display;
    $children_displays = $this
      ->get_children_chart_displays();
    foreach ($children_displays as $child_display_id => $child_display) {

      // If the user doesn't have access to the child display, skip.
      if (!$this->view
        ->access($child_display_id)) {
        continue;
      }

      // Generate the subchart by executing the child display. We load a fresh
      // view here to avoid collisions in shifting the current display while in
      // a display.
      $subview = $this->view
        ->clone_view();
      $subview
        ->set_display($child_display_id);

      // Copy the settings for our axes over to the child view.
      foreach ($this->options as $option_name => $option_value) {
        if (strpos($option_name, 'yaxis') === 0 && $child_display->handler
          ->get_option('inherit_yaxis')) {
          $subview->display_handler->options['style_options'][$option_name] = $option_value;
        }
        elseif (strpos($option_name, 'xaxis') === 0) {
          $subview->display_handler->options['style_options'][$option_name] = $option_value;
        }
      }

      // Inherit arguments and exposed filters if set to.
      if ($child_display->handler
        ->get_option('inherit_arguments')) {
        $subview->original_args = $subview->args;
        $args = $this->view->args;
        $subview
          ->set_arguments($args);
      }

      // Exposed filters.
      if ($child_display->handler
        ->get_option('inherit_exposed_filters')) {
        $exposed_input = $this->view->exposed_input;
        $subview
          ->set_exposed_input($exposed_input);
      }

      // Execute the subview and get the result.
      $subview
        ->pre_execute();
      $subview
        ->execute();

      // If there's no results, don't attach the subview.
      if (empty($subview->result)) {
        continue;
      }
      $subchart = $subview->style_plugin
        ->render($subview->result);
      $subview
        ->post_execute();
      unset($subview);

      // Create a secondary axis if needed.
      if (!$child_display->handler
        ->get_option('inherit_yaxis') && isset($subchart['yaxis'])) {
        $chart['secondary_yaxis'] = $subchart['yaxis'];
        $chart['secondary_yaxis']['#opposite'] = TRUE;
      }

      // Merge in the child chart data.
      foreach (element_children($subchart) as $key) {
        if ($subchart[$key]['#type'] === 'chart_data') {
          $chart[$key] = $subchart[$key];

          // If the subchart is a different type than the parent chart, set
          // the #chart_type property on the individual chart data elements.
          if ($subchart['#chart_type'] !== $chart['#chart_type']) {
            $chart[$key]['#chart_type'] = $subchart['#chart_type'];
          }
          if (!$child_display->handler
            ->get_option('inherit_yaxis')) {
            $chart[$key]['#target_axis'] = 'secondary_yaxis';
          }
        }
      }
    }

    // Print the chart.
    return $chart;
  }

  /**
   * Utility function to check if this chart has a parent display.
   */
  function get_parent_chart_display() {
    $parent_display = FALSE;
    if ($this->plugin_name === 'chart_extension' && $this->display && $this->display->handler->options['parent_display']) {
      $parent_display_name = $this->display->handler
        ->get_option('parent_display');
      if (isset($this->view->display[$parent_display_name])) {
        $parent_display = $this->view->display[$parent_display_name];
      }
    }

    // Ensure the parent is a chart.
    if ($parent_display && $parent_display->handler
      ->get_option('style_plugin') !== 'chart') {
      $parent_display = FALSE;
    }
    return $parent_display;
  }

  /**
   * Utility function to check if this chart has children displays.
   */
  function get_children_chart_displays() {
    $children_displays = array();
    foreach ($this->view->display as $display_name => $display) {
      $display_enabled = $this->view->display[$display_name]->handler
        ->get_option('enabled');
      if ($display->display_plugin === 'chart' && $display->display_options['parent_display'] && empty($display->deleted) && $display_enabled) {
        $parent_display_name = $display->display_options['parent_display'];
        if ($parent_display_name === $this->view->current_display) {
          $children_displays[$display_name] = $this->view->display[$display_name];
        }
      }
    }
    return $children_displays;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
charts_plugin_style_chart::get_children_chart_displays		function	Utility function to check if this chart has children displays.
charts_plugin_style_chart::get_parent_chart_display		function	Utility function to check if this chart has a parent display.
charts_plugin_style_chart::options_form		function	Generate a form for setting options. Overrides views_plugin_style::options_form
charts_plugin_style_chart::options_submit		function	Generate a form for setting options. Overrides views_plugin::options_submit
charts_plugin_style_chart::option_definition		function	Set default options. Overrides views_plugin_style::option_definition
charts_plugin_style_chart::render		function	Render the entire view from the view result. Overrides views_plugin_style::render
charts_plugin_style_chart::validate		function	Make sure the display and all associated handlers are valid. Overrides views_plugin_style::validate
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::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.

You are here

class charts_plugin_style_chart in Charts 7.2

Hierarchy

File

Members

API Navigation