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