libraries/tbl_chart.lib.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3
   4 /**
   5  * functions for displaying chart
   6  *
   7  * @usedby  tbl_chart.php
   8  *
   9  * @package PhpMyAdmin
  10  */
  11 if (! defined('PHPMYADMIN')) {
  12     exit;
  13 }
  14
  15 /**
  16  * Function to get html for pma_token and url_query
  17  *
  18  * @param string $url_query url query
  19  *
  20  * @return string
  21  */
  22 function PMA_getHtmlForPmaTokenAndUrlQuery($url_query)
  23 {
  24     $htmlString = '<script type="text/javascript">'
  25         . "pma_token = '" . $_SESSION[' PMA_token '] . "';"
  26         . "url_query = '" . $url_query . "';"
  27         . '</script>';
  28     return $htmlString;
  29 }
  30
  31 /**
  32  * Function to get html for the chart type options
  33  *
  34  * @return string
  35  */
  36 function PMA_getHtmlForChartTypeOptions()
  37 {
  38     $html = '<input type="radio" name="chartType" value="bar" id="radio_bar" />'
  39         . '<label for ="radio_bar">' . _pgettext('Chart type', 'Bar') . '</label>'
  40         . '<input type="radio" name="chartType" value="column" id="radio_column" />'
  41         . '<label for ="radio_column">' . _pgettext('Chart type', 'Column')
  42         . '</label>'
  43         . '<input type="radio" name="chartType" value="line" id="radio_line"'
  44         . ' checked="checked" />'
  45         . '<label for ="radio_line">' . _pgettext('Chart type', 'Line') . '</label>'
  46         . '<input type="radio" name="chartType" value="spline" id="radio_spline" />'
  47         . '<label for ="radio_spline">' . _pgettext('Chart type', 'Spline')
  48         . '</label>'
  49         . '<input type="radio" name="chartType" value="area" id="radio_area" />'
  50         . '<label for ="radio_area">' . _pgettext('Chart type', 'Area') . '</label>'
  51         . '<span class="span_pie" style="display:none;">'
  52         . '<input type="radio" name="chartType" value="pie" id="radio_pie" />'
  53         . '<label for ="radio_pie">' . _pgettext('Chart type', 'Pie') . '</label>'
  54         . '</span>'
  55         . '<span class="span_timeline" style="display:none;">'
  56         . '<input type="radio" name="chartType" '
  57         . 'value="timeline" id="radio_timeline" />'
  58         . '<label for ="radio_timeline">' . _pgettext('Chart type', 'Timeline')
  59         . '</label>'
  60         . '</span>'
  61         . '<span class="span_scatter" style="display:none;">'
  62         . '<input type="radio" name="chartType" '
  63         . 'value="scatter" id="radio_scatter" />'
  64         . '<label for ="radio_scatter">' . _pgettext('Chart type', 'Scatter')
  65         . '</label>'
  66         . '</span>'
  67         . '<br /><br />';
  68
  69     return $html;
  70 }
  71
  72 /**
  73  * Function to get html for the bar stacked option
  74  *
  75  * @return string
  76  */
  77 function PMA_getHtmlForStackedOption()
  78 {
  79     $html = '<span class="barStacked" style="display:none;">'
  80     . '<input type="checkbox" name="barStacked" value="1"'
  81     . ' id="checkbox_barStacked" />'
  82     . '<label for ="checkbox_barStacked">' . __('Stacked') . '</label>'
  83     . '</span>'
  84     . '<br /><br />';
  85
  86     return $html;
  87 }
  88
  89 /**
  90  * Function to get html for the chart x axis options
  91  *
  92  * @param array $keys   keys
  93  * @param int   &$xaxis x axis
  94  *
  95  * @return string
  96  */
  97 function PMA_getHtmlForChartXAxisOptions($keys, &$xaxis)
  98 {
  99     $htmlString = '<div style="float:left; padding-left:40px;">'
 100         . '<label for="select_chartXAxis">' .  __('X-Axis:') . '</label>'
 101         . '<select name="chartXAxis" id="select_chartXAxis">';
 102
 103     foreach ($keys as $idx => $key) {
 104         if ($xaxis === null) {
 105             $htmlString .= '<option value="' . htmlspecialchars($idx)
 106                 . '" selected="selected">' . htmlspecialchars($key) . '</option>';
 107             $xaxis = $idx;
 108         } else {
 109             $htmlString .= '<option value="' . htmlspecialchars($idx) . '">'
 110                 . htmlspecialchars($key) . '</option>';
 111         }
 112     }
 113     $htmlString .= '</select>';
 114
 115     return $htmlString;
 116 }
 117
 118 /**
 119  * Function to get html for chart series options
 120  *
 121  * @param array $keys                 keys
 122  * @param array $fields_meta          fields meta
 123  * @param array $numeric_types        numeric types
 124  * @param int   $xaxis                x axis
 125  * @param int   $numeric_column_count numeric column count
 126  *
 127  * @return string
 128  */
 129 function PMA_getHtmlForChartSeriesOptions($keys, $fields_meta, $numeric_types,
 130     $xaxis, $numeric_column_count
 131 ) {
 132     $htmlString = '<br />'
 133         . '<label for="select_chartSeries">' . __('Series:') . '</label>'
 134         . '<select name="chartSeries" id="select_chartSeries" multiple="multiple">';
 135
 136     foreach ($keys as $idx => $key) {
 137         if (in_array($fields_meta[$idx]->type, $numeric_types)) {
 138             if ($idx == $xaxis && $numeric_column_count > 1) {
 139                 $htmlString .= '<option value="' . htmlspecialchars($idx) . '">'
 140                     . htmlspecialchars($key) . '</option>';
 141             } else {
 142                 $htmlString .= '<option value="' . htmlspecialchars($idx)
 143                     . '" selected="selected">' . htmlspecialchars($key)
 144                     . '</option>';
 145             }
 146         }
 147     }
 148     $htmlString .= '</select>';
 149     return $htmlString;
 150 }
 151
 152 /**
 153  * Function to get html for date time columns
 154  *
 155  * @param array $keys        keys
 156  * @param array $fields_meta fields meta
 157  *
 158  * @return string
 159  */
 160 function PMA_getHtmlForDateTimeCols($keys, $fields_meta)
 161 {
 162     $htmlString = '<input type="hidden" name="dateTimeCols" value="';
 163
 164     $date_time_types = array('date', 'datetime', 'timestamp');
 165     foreach ($keys as $idx => $key) {
 166         if (in_array($fields_meta[$idx]->type, $date_time_types)) {
 167             $htmlString .= $idx . " ";
 168         }
 169     }
 170     $htmlString .= '" />';
 171
 172     return $htmlString;
 173 }
 174
 175 /**
 176  * Function to get html for date time columns
 177  *
 178  * @param array $keys          keys
 179  * @param array $fields_meta   fields meta
 180  * @param array $numeric_types numeric types
 181  *
 182  * @return string
 183  */
 184 function PMA_getHtmlForNumericCols($keys, $fields_meta, $numeric_types)
 185 {
 186     $htmlString = '<input type="hidden" name="numericCols" value="';
 187     foreach ($keys as $idx => $key) {
 188         if (in_array($fields_meta[$idx]->type, $numeric_types)) {
 189             $htmlString .= $idx . " ";
 190         }
 191     }
 192     $htmlString .= '" />';
 193
 194     return $htmlString;
 195 }
 196
 197 /**
 198  * Function to get html for the table axis label options
 199  *
 200  * @param int   $xaxis x axis
 201  * @param array $keys  keys
 202  *
 203  * @return string
 204  */
 205 function PMA_getHtmlForTableAxisLabelOptions($xaxis, $keys)
 206 {
 207     $htmlString = '<div style="float:left; padding-left:40px;">'
 208     . '<label for="xaxis_label">' . __('X-Axis label:') . '</label>'
 209     . '<input style="margin-top:0;" type="text" name="xaxis_label" id="xaxis_label"'
 210     . ' value="'
 211     . (($xaxis == -1) ? __('X Values') : htmlspecialchars($keys[$xaxis]))
 212     . '" /><br />'
 213     . '<label for="yaxis_label">' . __('Y-Axis label:') . '</label>'
 214     . '<input type="text" name="yaxis_label" id="yaxis_label" value="'
 215     . __('Y Values') . '" /><br />'
 216     . '</div>';
 217
 218     return $htmlString;
 219 }
 220
 221 /**
 222  * Function to get html for switching to alternative data format
 223  *
 224  * @param array $keys          keys
 225  * @param array $fields_meta   fields meta
 226  * @param array $numeric_types numeric types
 227  * @param int   $xaxis         x axis
 228  *
 229  * @return string
 230  */
 231 function PMA_getHtmlForAlternativeDataFormat($keys, $fields_meta, $numeric_types,
 232     $xaxis
 233 ) {
 234     $htmlString = '<p style="clear:both;">&nbsp;</p>'
 235         . '<div><input type="checkbox" id="chkAlternative" '
 236         . 'name="chkAlternative" value="alternativeFormat">'
 237         . __('Series names are in a column') . '</input>';
 238
 239     $htmlString .= '<br />'
 240         . '<label for="select_seriesColumn">' . __('Series column:') . '</label>'
 241         . '<select name="chartSeriesColumn" id="select_seriesColumn" disabled>';
 242     foreach ($keys as $idx => $key) {
 243         $htmlString .= '<option value="' . htmlspecialchars($idx) . '"';
 244         if ($idx == 1) {
 245             $htmlString .= ' selected="selected"';
 246             $seriesColumn = $idx;
 247         }
 248         $htmlString .= '>' . htmlspecialchars($key) . '</option>';
 249     }
 250     $htmlString .= '</select>';
 251
 252     $htmlString .= '<label for="select_valueColumn">'
 253         . __('Value column:') . '</label>'
 254         . '<select name="chartValueColumn" id="select_valueColumn" disabled>';
 255
 256     $selected = false;
 257     foreach ($keys as $idx => $key) {
 258         if (in_array($fields_meta[$idx]->type, $numeric_types)) {
 259             if (! $selected && $idx != $xaxis && $idx != $seriesColumn) {
 260                 $htmlString .= '<option value="' . htmlspecialchars($idx)
 261                     . '" selected="selected">' . htmlspecialchars($key)
 262                     . '</option>';
 263                 $selected = true;
 264             } else {
 265                 $htmlString .= '<option value="' . htmlspecialchars($idx) . '">'
 266                     . htmlspecialchars($key) . '</option>';
 267             }
 268         }
 269     }
 270     $htmlString .= '</select></div>';
 271     return $htmlString;
 272 }
 273
 274 /**
 275  * Function to get html for the start row and number of rows options
 276  *
 277  * @param string $sql_query sql query
 278  *
 279  * @return string
 280  */
 281 function PMA_getHtmlForStartAndNumberOfRowsOptions($sql_query)
 282 {
 283     $htmlString = '<p style="clear:both;">&nbsp;</p>'
 284         . '<fieldset>'
 285         . '<div>'
 286         . '<label for="pos">' . __('Start row:') . '</label>'
 287         . '<input type="text" name="pos" size="3" value="'
 288         . $_SESSION['tmpval']['pos'] . '" />'
 289         . '<label for="session_max_rows">'
 290         . __('Number of rows:') . '</label>'
 291         . '<input type="text" name="session_max_rows" size="3" value="'
 292         . (($_SESSION['tmpval']['max_rows'] != 'all')
 293             ? $_SESSION['tmpval']['max_rows']
 294             : $GLOBALS['cfg']['MaxRows'])
 295         . '" />'
 296         . '<input type="submit" name="submit" class="Go" value="' . __('Go')
 297         . '" />'
 298         . '<input type="hidden" name="sql_query" value="'
 299         . htmlspecialchars($sql_query) . '" />'
 300         . '</div>'
 301         . '</fieldset>';
 302
 303     return $htmlString;
 304 }
 305
 306 /**
 307  * Function to get html for the chart area div
 308  *
 309  * @return string
 310  */
 311 function PMA_getHtmlForChartAreaDiv()
 312 {
 313     $htmlString = '<p style="clear:both;">&nbsp;</p>'
 314         . '<div id="resizer" style="width:600px; height:400px;">'
 315         . '<div id="saveChart"'
 316         . ' style="position: absolute; right: 10px;'
 317         . ' top: 10px; cursor: pointer; z-index: 1000;">'
 318         . PMA_Util::getImage('b_saveimage', __('Save chart as image'))
 319         . '</div>'
 320         . '<div id="querychart">'
 321         . '</div>'
 322         . '</div>';
 323
 324     return $htmlString;
 325 }
 326
 327 /**
 328  * Function to get html for displaying table chart
 329  *
 330  * @param string $url_query            url query
 331  * @param array  $url_params           url parameters
 332  * @param array  $keys                 keys
 333  * @param array  $fields_meta          fields meta
 334  * @param array  $numeric_types        numeric types
 335  * @param int    $numeric_column_count numeric column count
 336  * @param string $sql_query            sql query
 337  *
 338  * @return string
 339  */
 340 function PMA_getHtmlForTableChartDisplay($url_query, $url_params, $keys,
 341     $fields_meta, $numeric_types, $numeric_column_count, $sql_query
 342 ) {
 343     // pma_token/url_query needed for chart export
 344     $htmlString = PMA_getHtmlForPmaTokenAndUrlQuery($url_query);
 345     $htmlString .= '<!-- Display Chart options -->'
 346         . '<div id="div_view_options">'
 347         . '<form method="post" id="tblchartform" action="tbl_chart.php" '
 348         . 'class="ajax">'
 349         . PMA_URL_getHiddenInputs($url_params)
 350         . '<fieldset>'
 351         . '<legend>' . __('Display chart') . '</legend>'
 352         . '<div style="float:left; width:420px;">';
 353     $htmlString .= PMA_getHtmlForChartTypeOptions();
 354     $htmlString .= PMA_getHtmlForStackedOption();
 355
 356     $htmlString .= '<input type="text" name="chartTitle" value="'
 357         . __('Chart title')
 358         . '">'
 359         . '</div>';
 360     $xaxis = null;
 361     $htmlString .= PMA_getHtmlForChartXAxisOptions($keys, $xaxis);
 362     $htmlString .= PMA_getHtmlForChartSeriesOptions(
 363         $keys, $fields_meta, $numeric_types, $xaxis, $numeric_column_count
 364     );
 365     $htmlString .= PMA_getHtmlForDateTimeCols($keys, $fields_meta);
 366     $htmlString .= PMA_getHtmlForNumericCols($keys, $fields_meta, $numeric_types);
 367     $htmlString .= '</div>';
 368
 369     $htmlString .= PMA_getHtmlForTableAxisLabelOptions($xaxis, $keys);
 370     $htmlString .= PMA_getHtmlForAlternativeDataFormat(
 371         $keys, $fields_meta, $numeric_types, $xaxis
 372     );
 373     $htmlString .= PMA_getHtmlForStartAndNumberOfRowsOptions($sql_query);
 374
 375     $htmlString .= PMA_getHtmlForChartAreaDiv();
 376
 377     $htmlString .= '</fieldset>'
 378         . '</form>'
 379         . '</div>';
 380
 381     return $htmlString;
 382 }
 383 ?>