libraries/svg_plot/pma_scatter_plot.php

   1 <?php
   2 /**
   3  * Generates the SVG needed for the plot
   4  *
   5  * @package phpMyAdmin
   6  */
   7
   8 require_once 'pma_svg_data_point.php';
   9
  10 class PMA_Scatter_Plot
  11 {
  12     /**
  13      * @var array   Raw data for the plot
  14      */
  15     private $_data;
  16
  17     /**
  18      * @var array   Data points of the plot
  19      */
  20     private $_dataPoints;
  21
  22     /**
  23      * @var array   Set of default settigs values are here.
  24      */
  25     private $_settings = array(
  26
  27         // Array of colors to be used for plot.
  28         'colors' => array(
  29             '#BCE02E',
  30             '#E0642E',
  31             '#E0D62E',
  32             '#2E97E0',
  33             '#B02EE0',
  34             '#E02E75',
  35             '#5CE02E',
  36             '#E0B02E',
  37             '#000000',
  38             '#0022E0',
  39             '#726CB1',
  40             '#481A36',
  41             '#BAC658',
  42             '#127224',
  43             '#825119',
  44             '#238C74',
  45             '#4C489B',
  46             '#87C9BF',
  47         ),
  48         // Plot background color.
  49         'bgColor' => '#84AD83',
  50
  51         // The width of the plot.
  52         'width' => 520,
  53
  54          // The height of the plot.
  55         'height' => 325,
  56
  57         // Default X Axis label. If empty, label will be taken from the data.
  58         'xLabel' => '',
  59
  60         // Default Y Axis label. If empty, label will be taken from the data.
  61         'yLabel' => '',
  62
  63         // Data point label. If empty, label will be taken from the data.
  64         'dataLabel' => '',
  65
  66     );
  67
  68     /**
  69      * @var array   Options that the user has specified.
  70      */
  71     private $_userSpecifiedSettings = null;
  72
  73     /**
  74      * Returns the settings array
  75      *
  76      * @return the settings array.
  77      */
  78     public function getSettings()
  79     {
  80         return $this->_settings;
  81     }
  82
  83     /**
  84      * Returns the data array
  85      *
  86      * @return the data array.
  87      */
  88     public function getData()
  89     {
  90         return $this->_data;
  91     }
  92
  93     /**
  94      * Constructor. Stores user specified options.
  95      *
  96      * @param array $data    Data for the visualization
  97      * @param array $options Users specified options
  98      */
  99     public function __construct($data, $options)
 100     {
 101         $this->_userSpecifiedSettings = $options;
 102         $this->_data = $data;
 103     }
 104
 105     /**
 106      * All the variable initialization, options handling has to be done here.
 107      */
 108     protected function init()
 109     {
 110         $this->_handleOptions();
 111     }
 112
 113     /**
 114      * A function which handles passed parameters. Useful if desired
 115      * chart needs to be a little bit different from the default one.
 116      */
 117     private function _handleOptions()
 118     {
 119         $this->_dataPoints = array();
 120         if (! is_null($this->_userSpecifiedSettings)) {
 121             foreach (array_keys($this->_userSpecifiedSettings) as $key){
 122                 $this->_settings[$key] = $this->_userSpecifiedSettings[$key];
 123             }
 124         }
 125         if ($this->_settings['dataLabel'] == '') {
 126                 $labels = array_keys($this->_data[0]);
 127                 $this->_settings['dataLabel'] = $labels[0];
 128         }
 129     }
 130
 131     /**
 132      * Generate the visualization in SVG format.
 133      *
 134      * @return the generated image resource
 135      */
 136     private function _svg()
 137     {
 138         $this->init();
 139
 140         $output   = '<?xml version="1.0" encoding="UTF-8" standalone="no"?>' . "\n";
 141         $output  .= '<svg version="1.1" xmlns:svg="http://www.w3.org/2000/svg"'
 142             . ' xmlns="http://www.w3.org/2000/svg" width="' . $this->_settings['width'] . '"'
 143             . ' height="' . $this->_settings['height'] . '">';
 144         $output .= '<g id="groupPanel">';
 145         $output .= '<defs>
 146                     <path id="myTextPath1"
 147                     d="M10,190 L10,50"/>
 148                     <path id="myTextPath2"
 149                     d="M250,10 L370,10"/>
 150                     </defs>';
 151         $output .= '<text x="6" y="190"  style="font-family: Arial; font-size  : 54; stroke:none; fill:#000000;" >
 152                     <textPath xlink:href="#myTextPath1" >';
 153         $output .= $this->_settings['yLabel'];
 154         $output .= '</textPath>
 155                    </text>';
 156
 157         $output .= '<text x="250" y="10"  style="font-family: Arial; font-size  : 54; stroke:none; fill:#000000;" >
 158                     <textPath xlink:href="#myTextPath2" >';
 159         $output .= $this->_settings['xLabel'];
 160         $output .= '</textPath>
 161                    </text>';
 162
 163
 164         $scale_data = $this->_scaleDataSet($this->_data, $this->_settings['xLabel'], $this->_settings['yLabel']);
 165         $output .= $this->_prepareDataSet($this->_data, 0, $scale_data, $this->_settings['dataLabel']);
 166
 167         $output .= '</g>';
 168         $output .= '</svg>';
 169
 170         return $output;
 171     }
 172
 173     /**
 174      * Get the visualization as a SVG.
 175      *
 176      * @return the visualization as a SVG
 177      */
 178     public function asSVG()
 179     {
 180         $output = $this->_svg();
 181         return $output;
 182     }
 183
 184     /**
 185      * Calculates the scale, horizontal and vertical offset that should be used.
 186      *
 187      * @param array $data Row data
 188      *
 189      * @return an array containing the scale, x and y offsets
 190      */
 191     private function _scaleDataSet($data,$xField,$yField)
 192     {
 193
 194         // Currently assuming only numeric fields are selected
 195         $coordinates = array();
 196         foreach ($data as $row) {
 197             $coordinates[0][] = $row[$xField];
 198             $coordinates[1][] = $row[$yField];
 199         }
 200         for ($i = 0 ; $i < 2 ; $i++) {
 201
 202             $maxC = ($i == 0) ? 500 : 320;
 203
 204             if( !is_numeric($coordinates[$i][0])) {
 205                 $uniqueC = array_unique($coordinates[$i]);
 206                 $countC = count(array_unique($coordinates[$i]));
 207                 $map = $tmp = array();
 208                 foreach ($uniqueC as $uc) {
 209                         $tmp[] = $uc;
 210                 }
 211                 for ($j = 0 ; $j < $countC ; $j++) {
 212                     $map[$tmp[$j]] = 20 + $j * $maxC / $countC;
 213                 }
 214                 for($j = 0 ; $j < count($coordinates[$i]) ; $j++) {
 215                         $coordinates[$i][$j] = $map[$coordinates[$i][$j]];
 216                 }
 217
 218             }
 219             elseif (is_numeric($coordinates[$i][0])) {
 220
 221                 $maxC = max($coordinates[$i]);
 222                 for($j = 0 ; $j < count($coordinates[$i]) ; $j++) {
 223
 224                     if ($i == 0)
 225                         $coordinates[$i][$j] = 20 + 500 * $coordinates[$i][$j] / $maxC;
 226                     else
 227                         $coordinates[$i][$j] = 20 + 320 * (1 - $coordinates[$i][$j] / $maxC);
 228                 }
 229             }
 230         }
 231         return $coordinates;
 232     }
 233
 234     /**
 235      * Prepares and return the dataset as needed by the visualization.
 236      *
 237      * @param array  $data         Raw data
 238      * @param int    $color_number Start index to the color array
 239      * @param array  $scale_data   Data related to scaling
 240      * @param string $label        Label for the data points
 241      * @param image  $results      Image object in the case of png
 242      *
 243      * @return the formatted array of data.
 244      */
 245     private function _prepareDataSet($data, $color_number, $scale_data, $label)
 246     {
 247         $result = '';
 248         // loop through the rows
 249         for($i = 0 ; $i < count($data) ; $i++) {
 250
 251             $index = $color_number % sizeof($this->_settings['colors']);
 252
 253             $data_element = new PMA_SVG_Data_Point($scale_data[0][$i],$scale_data[1][$i],$data[$i][$label],$data[$i]);
 254
 255             $options = array('color' => $this->_settings['colors'][$index], 'id' => $i);
 256             $this->_dataPoints[] = $data_element;
 257
 258             $result .= $data_element->prepareRowAsSVG($options);
 259             $color_number++;
 260         }
 261
 262
 263         return $result;
 264     }
 265 }
 266 ?>
 267