libraries/chart/pma_pchart_chart.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Holds the base class that all charts using pChart inherit from and some
   5  * widely used constants
   6  * @author Martynas Mickevicius <mmartynas@gmail.com>
   7  * @package phpMyAdmin
   8  */
   9
  10 /**
  11  *
  12  */
  13 define('TOP', 0);
  14 define('RIGHT', 1);
  15 define('BOTTOM', 2);
  16 define('LEFT', 3);
  17
  18 require_once 'pma_chart.php';
  19
  20 require_once 'pChart/pData.class';
  21 require_once 'pChart/pChart.class';
  22
  23 /**
  24  * Base class for every chart implemented using pChart.
  25  * @abstract
  26  * @package phpMyAdmin
  27  */
  28 abstract class PMA_pChart_chart extends PMA_chart
  29 {
  30     /**
  31      * @var String  title text
  32      */
  33     protected $titleText;
  34
  35     /**
  36      * @var array   data for the chart
  37      */
  38     protected $data;
  39
  40     /**
  41      * @var object  pData object that holds the description of the data
  42      */
  43     protected $dataSet;
  44
  45     /**
  46      * @var object  pChart object that holds the chart
  47      */
  48     protected $chart;
  49
  50     /**
  51      * @var array   holds base64 encoded chart image parts
  52      */
  53     protected $partsEncoded = array();
  54
  55     public function __construct($data, $options = null)
  56     {
  57         parent::__construct($options);
  58
  59         $this->data = $data;
  60
  61         $this->settings['fontPath'] = './libraries/chart/pChart/fonts/';
  62
  63         $this->settings['scale'] = SCALE_ADDALLSTART0;
  64
  65         $this->settings['labelHeight'] = 20;
  66
  67         $this->settings['fontSize'] = 8;
  68
  69         $this->settings['continuous'] = 'off';
  70
  71         // as in CSS (top, right, bottom, left)
  72         $this->setAreaMargins(array(20, 20, 40, 60));
  73
  74         // when graph area gradient is used, this is the color of the graph
  75         // area border
  76         $this->settings['graphAreaColor'] = '#D5D9DD';
  77
  78         // the background color of the graph area
  79         $this->settings['graphAreaGradientColor'] = '#A3CBA7';
  80
  81         // the color of the grid lines in the graph area
  82         $this->settings['gridColor'] = '#E6E6E6';
  83
  84         // the color of the scale and the labels
  85         $this->settings['scaleColor'] = '#D5D9DD';
  86
  87         $this->settings['titleBgColor'] = '#000000';
  88     }
  89
  90     protected function init()
  91     {
  92         parent::init();
  93
  94         // create pChart object
  95         $this->chart = new pChart($this->getWidth(), $this->getHeight());
  96
  97         // create pData object
  98         $this->dataSet = new pData;
  99
 100         $this->chart->reportWarnings('GD');
 101         $this->chart->ErrorFontName = $this->getFontPath().'tahoma.ttf';
 102
 103         // initialize colors
 104         foreach ($this->getColors() as $key => $color) {
 105             $this->chart->setColorPalette(
 106                     $key,
 107                     hexdec(substr($color, 1, 2)),
 108                     hexdec(substr($color, 3, 2)),
 109                     hexdec(substr($color, 5, 2))
 110             );
 111         }
 112
 113         $this->chart->setFontProperties($this->getFontPath().'tahoma.ttf', $this->getFontSize());
 114
 115         $this->chart->setImageMap(true, 'mapid');
 116     }
 117
 118     /**
 119      * data is put to the $dataSet object according to what type chart is
 120      * @abstract
 121      */
 122     abstract protected function prepareDataSet();
 123
 124     /**
 125      * all components of the chart are drawn
 126      */
 127     protected function prepareChart()
 128     {
 129         $this->drawBackground();
 130         $this->drawChart();
 131     }
 132
 133     /**
 134      * draws the background
 135      */
 136     protected function drawBackground()
 137     {
 138         $this->drawCommon();
 139         $this->drawTitle();
 140         $this->setGraphAreaDimensions();
 141         $this->drawGraphArea();
 142     }
 143
 144     /**
 145      * draws the part of the background which is common to most of the charts
 146      */
 147     protected function drawCommon()
 148     {
 149         $this->chart->drawGraphAreaGradient(
 150                 $this->getBgColor(RED),
 151                 $this->getBgColor(GREEN),
 152                 $this->getBgColor(BLUE),
 153                 50,TARGET_BACKGROUND);
 154         $this->chart->addBorder(2);
 155     }
 156
 157     /**
 158      * draws the chart title
 159      */
 160     protected function drawTitle()
 161     {
 162         // Draw the title
 163         $this->chart->drawTextBox(
 164                 0,
 165                 0,
 166                 $this->getWidth(),
 167                 $this->getLabelHeight(),
 168                 $this->getTitleText(),
 169                 0,
 170                 $this->getTitleColor(RED),
 171                 $this->getTitleColor(GREEN),
 172                 $this->getTitleColor(BLUE),
 173                 ALIGN_CENTER,
 174                 True,
 175                 $this->getTitleBgColor(RED),
 176                 $this->getTitleBgColor(GREEN),
 177                 $this->getTitleBgColor(BLUE),
 178                 30
 179         );
 180     }
 181
 182     /**
 183      * calculates and sets the dimensions that will be used for the actual graph
 184      */
 185     protected function setGraphAreaDimensions()
 186     {
 187         $this->chart->setGraphArea(
 188                 $this->getAreaMargin(LEFT),
 189                 $this->getLabelHeight() + $this->getAreaMargin(TOP),
 190                 $this->getWidth() - $this->getAreaMargin(RIGHT),
 191                 $this->getHeight() - $this->getAreaMargin(BOTTOM)
 192         );
 193     }
 194
 195     /**
 196      * draws graph area (the area where all bars, lines, points will be seen)
 197      */
 198     protected function drawGraphArea()
 199     {
 200         $this->chart->drawGraphArea(
 201                 $this->getGraphAreaColor(RED),
 202                 $this->getGraphAreaColor(GREEN),
 203                 $this->getGraphAreaColor(BLUE),
 204                 FALSE
 205         );
 206         $this->chart->drawScale(
 207                 $this->dataSet->GetData(),
 208                 $this->dataSet->GetDataDescription(),
 209                 $this->getScale(),
 210                 $this->getScaleColor(RED),
 211                 $this->getScaleColor(GREEN),
 212                 $this->getScaleColor(BLUE),
 213                 TRUE,0,2,TRUE
 214         );
 215         $this->chart->drawGraphAreaGradient(
 216                 $this->getGraphAreaGradientColor(RED),
 217                 $this->getGraphAreaGradientColor(GREEN),
 218                 $this->getGraphAreaGradientColor(BLUE),
 219                 50
 220         );
 221         $this->chart->drawGrid(
 222                 4,
 223                 TRUE,
 224                 $this->getGridColor(RED),
 225                 $this->getGridColor(GREEN),
 226                 $this->getGridColor(BLUE),
 227                 20
 228         );
 229     }
 230
 231     /**
 232      * draws the chart
 233      * @abstract
 234      */
 235     protected abstract function drawChart();
 236
 237     /**
 238      * Renders the chart, base 64 encodes the output and puts it into
 239      * array partsEncoded.
 240      *
 241      * Parameter can be used to slice the chart vertically into parts. This
 242      * solves an issue where some browsers (IE8) accept base64 images only up
 243      * to some length.
 244      *
 245      * @param   integer  $parts         number of parts to render.
 246      *                                  Default value 1 means that all the
 247      *                                  chart will be in one piece.
 248      */
 249     protected function render($parts = 1)
 250     {
 251         $fullWidth = 0;
 252
 253         for ($i = 0; $i < $parts; $i++) {
 254
 255             // slicing is vertical so part height is the full height
 256             $partHeight = $this->chart->YSize;
 257
 258             // there will be some rounding erros, will compensate later
 259             $partWidth = round($this->chart->XSize / $parts);
 260             $fullWidth += $partWidth;
 261             $partX = $partWidth * $i;
 262
 263             if ($i == $parts - 1) {
 264                 // if this is the last part, compensate for the rounding errors
 265                 $partWidth += $this->chart->XSize - $fullWidth;
 266             }
 267
 268             // get a part from the full chart image
 269             $part = imagecreatetruecolor($partWidth, $partHeight);
 270             imagecopy($part, $this->chart->Picture, 0, 0, $partX, 0, $partWidth, $partHeight);
 271
 272             // render part and save it to variable
 273             ob_start();
 274             imagepng($part, NULL, 9, PNG_ALL_FILTERS);
 275             $output = ob_get_contents();
 276             ob_end_clean();
 277
 278             // base64 encode the current part
 279             $partEncoded = base64_encode($output);
 280             $this->partsEncoded[$i] = $partEncoded;
 281         }
 282     }
 283
 284     /**
 285      * get the HTML and JS code for the configured chart
 286      * @return string   HTML and JS code for the chart
 287      */
 288     public function toString()
 289     {
 290         if (!function_exists('gd_info')) {
 291             array_push($this->errors, ERR_NO_GD);
 292             return '';
 293         }
 294
 295         $this->init();
 296         $this->prepareDataSet();
 297         $this->prepareChart();
 298
 299         //$this->chart->debugImageMap();
 300         //$this->chart->printErrors('GD');
 301
 302         // check if a user wanted a chart in one part
 303         if ($this->isContinuous()) {
 304             $this->render(1);
 305         }
 306         else {
 307             $this->render(20);
 308         }
 309
 310         $returnData = '<div id="chart">';
 311         foreach ($this->partsEncoded as $part) {
 312             $returnData .= '<img src="data:image/png;base64,'.$part.'" />';
 313         }
 314         $returnData .= '</div>';
 315
 316         // add tooltips only if json is available
 317         if (function_exists('json_encode')) {
 318             $returnData .= '
 319                 <script type="text/javascript">
 320                 //<![CDATA[
 321                     imageMap.loadImageMap(\''.json_encode($this->getImageMap()).'\');
 322                 //]]>
 323                 </script>
 324             ';
 325         }
 326         else {
 327             array_push($this->errors, ERR_NO_JSON);
 328         }
 329
 330         return $returnData;
 331     }
 332
 333     protected function getLabelHeight()
 334     {
 335         return $this->settings['labelHeight'];
 336     }
 337
 338     protected function setAreaMargins($areaMargins)
 339     {
 340         $this->settings['areaMargins'] = $areaMargins;
 341     }
 342
 343     protected function getAreaMargin($side)
 344     {
 345         return $this->settings['areaMargins'][$side];
 346     }
 347
 348     protected function getFontPath()
 349     {
 350         return $this->settings['fontPath'];
 351     }
 352
 353     protected function getScale()
 354     {
 355         return $this->settings['scale'];
 356     }
 357
 358     protected function getFontSize()
 359     {
 360         return $this->settings['fontSize'];
 361     }
 362
 363     protected function isContinuous()
 364     {
 365         return $this->settings['continuous'] == 'on';
 366     }
 367
 368     protected function getImageMap()
 369     {
 370         return $this->chart->getImageMap();
 371     }
 372
 373     protected function getGraphAreaColor($component)
 374     {
 375         return $this->hexStrToDecComp($this->settings['graphAreaColor'], $component);
 376     }
 377
 378     protected function getGraphAreaGradientColor($component)
 379     {
 380         return $this->hexStrToDecComp($this->settings['graphAreaGradientColor'], $component);
 381     }
 382
 383     protected function getGridColor($component)
 384     {
 385         return $this->hexStrToDecComp($this->settings['gridColor'], $component);
 386     }
 387
 388     protected function getScaleColor($component)
 389     {
 390         return $this->hexStrToDecComp($this->settings['scaleColor'], $component);
 391     }
 392
 393     protected function getTitleBgColor($component)
 394     {
 395         return $this->hexStrToDecComp($this->settings['titleBgColor'], $component);
 396     }
 397 }
 398
 399 ?>