source: branches/1.4/admin/images/phpBarGraph.php @ 12729

<?php
// +-----------------------------------------------------------------------+
// | PhpWebGallery - a PHP based picture gallery                           |
// | Copyright (C) 2002-2003 Pierrick LE GALL - pierrick@phpwebgallery.net |
// | Copyright (C) 2003-2005 PhpWebGallery Team - http://phpwebgallery.net |
// +-----------------------------------------------------------------------+
// | branch        : BSF (Best So Far)
// | file          : $RCSfile$
// | last update   : $Date: 2005-01-07 23:10:51 +0000 (Fri, 07 Jan 2005) $
// | last modifier : $Author: plg $
// | revision      : $Revision: 675 $
// +-----------------------------------------------------------------------+
// | This program is free software; you can redistribute it and/or modify  |
// | it under the terms of the GNU General Public License as published by  |
// | the Free Software Foundation                                          |
// |                                                                       |
// | This program is distributed in the hope that it will be useful, but   |
// | WITHOUT ANY WARRANTY; without even the implied warranty of            |
// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      |
// | General Public License for more details.                              |
// |                                                                       |
// | You should have received a copy of the GNU General Public License     |
// | along with this program; if not, write to the Free Software           |
// | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, |
// | USA.                                                                  |
// +-----------------------------------------------------------------------+

// Original PhpBarGraph Version 2.3 
// Written By TJ Hunter (tjhunter@ruistech.com)
// http://www.ruistech.com/phpBarGraph
// This class has been adapted to fill phpWG requirements

class PhpBarGraph
{
   /* -------------------------------- */
   /* Preference Variables             */
   /* -------------------------------- */
   var $_debug;
   var $_image;            // The image to print the bargraph too.
   var $_x;                // The starting column of the bargraph
   var $_y;                // The starting row of the bargraph
   var $_width;            // The width of the bargraph
   var $_height;           // The height of the bargraph
   var $_startBarColorHex; // The top color of the bargraph
   var $_endBarColorHex;   // The bottom color of the bargraph
   var $_lineColorHex;     // The color of the lines and text
   var $_barSpacing;       // The spacing width in between each bar
   var $_numOfValueTicks;  // The number of horizontal rule ticks
   var $_values;           // An array of arrays of the values of each bargraph and it's label
   var $_showLabels;       // If true, print the labels to the image
   var $_showValues;       // If true, print the values to the image
   var $_showBarBorder;    // If true, draws a box of around each bar
   var $_showFade;         // If true, draws each bar with a gradient
   var $_showOuterBox;     // If true, draws the box on the outside of the bargraph

   /* -------------------------------- */
   /* Private Variables                */
   /* -------------------------------- */
   var $_topMargin;
   var $_bottomMargin;
   var $_leftMargin;
   var $_rightMargin;
   var $_barWidth;
   var $_minBarHeight;
   var $_maxBarHeight;
   var $_realMinBarHeight;
   var $_realMaxBarHeight;
   var $_buffer;

   function PhpBarGraph()
   {
      $this->_debug = false;
      $this->_values = array();
      $this->_startBarColorHex = "0000ff";
      $this->_endBarColorHex = "ffffff";
      $this->_lineColorHex = "000000";
      $this->_barSpacing = 10;
      $this->_numOfValueTicks = 4;
      $this->_buffer = .5;
      $this->_showLabels = true;
      $this->_showValues = true;
      $this->_showBarBorder = true;
      $this->_showFade = true;
      $this->_showOuterBox = true;
   }

   function AddValue($labelName, $theValue)
   {
      array_push($this->_values, array("label" => $labelName, "value" => $theValue));
   }

   function SetDebug($debug)
   {
      $this->_debug = $debug;
   }

   function SetX($x)
   {
      $this->_x = $x;
   }

   function SetY($y)
   {
      $this->_y = $y;
   }

   function SetWidth($width)
   {
      $this->_width = $width;
   }

   function SetHeight($height)
   {
      $this->_height = $height;
   }

   function SetStartBarColor($color)
   {
      $this->_startBarColorHex = $color;
   }

   function SetEndBarColor($color)
   {
      $this->_endBarColorHex = $color;
   }

   function SetLineColor($color)
   {
      $this->_lineColorHex = $color;
   }

   function SetBarSpacing($barSpacing)
   {
      $this->_barSpacing = $barSpacing;
   }

   function SetNumOfValueTicks($ticks)
   {
      $this->_numOfValueTicks = $ticks;
   }

   function SetShowLabels($labels)
   {
      $this->_showLabels = $labels;
   }

   function SetShowValues($values)
   {
      $this->_showValues = $values;
   }

   function SetBarBorder($border)
   {
      $this->_showBarBorder = $border;
   }

   function SetShowFade($fade)
   {
      $this->_showFade = $fade;
   }

   function SetShowOuterBox($box)
   {
      $this->_showOuterBox = $box;
   }


   function RGBColor($hexColor) // Returns an array of decimal values from a hex color
   {
      $r = hexdec(substr($hexColor, 0, 2));
      $g = hexdec(substr($hexColor, 2, 2));
      $b = hexdec(substr($hexColor, 4, 2));

      $RGBColors = array("red" => $r, "green" => $g, "blue" => $b);

      return $RGBColors;
   }

   function DebugPrint() // Prints a bunch of debug information.
   {
      foreach($this->_values as $value)
      {
         echo $value["label"] . "=" . $value["value"] . "<br>\n";
      }

      $startColor = $this->RGBColor($this->_startBarColorHex);
      echo "StartColor: " . $startColor["red"] . ", " . $startColor["green"] . ", " . $startColor["blue"] . "<br>\n";

      $endColor = $this->RGBColor($this->_endBarColorHex);
      echo "EndColor: " . $endColor["red"] . ", " . $endColor["green"] . ", " . $endColor["blue"] . "<br>\n";

      $lineColor = $this->RGBColor($this->_lineColorHex);
      echo "LineColor: " . $lineColor["red"] . ", " . $lineColor["green"] . ", " . $lineColor["blue"] . "<br>\n";

      echo "x=" . $this->_x . "<br>\n";
      echo "y=" . $this->_y . "<br>\n";
      echo "width=" . $this->_width . "<br>\n";
      echo "height=" . $this->_height . "<br>\n";
      echo "startBarColorHex=" . $this->_startBarColorHex . "<br>\n";
      echo "endBarColorHex=" . $this->_endBarColorHex . "<br>\n";
      echo "lineColorHex=" . $this->_lineColorHex . "<br>\n";
      echo "barSpacing=" . $this->_barSpacing . "<br>\n";
      echo "numOfValueTicks=" . $this->_numOfValueTicks . "<br>\n";

   }

   function dif ($start,$end)
   {
           if ($start >= $end)
                   $dif = $start - $end;
        else
                $dif = $end - $start;
                
           return $dif;
   }

   function draw($start,$end,$pos,$step_width)
   {
        if ($start > $end)      
                $color = $start - $step_width * $pos;
        else
                $color = $start + $step_width * $pos;
                
        return $color;
   }    

   function fadeBar($image, $x1, $y1, $x2, $y2, $colorsStart, $colorsEnd, $height, $width) // Draws a rectangle with a gradient
   {
      $startColor = $this->RGBColor($colorsStart);
      $red_start = $startColor["red"];
      $green_start = $startColor["green"];
      $blue_start = $startColor["blue"];

      $endColor = $this->RGBColor($colorsEnd);
      $red_end = $endColor["red"];
      $green_end = $endColor["green"];
      $blue_end = $endColor["blue"];
      
      // difference between start and end
      $dif_red = $this->dif($red_start,$red_end);
      $dif_green = $this->dif($green_start,$green_end);
      $dif_blue = $this->dif($blue_start,$blue_end);
      
      $height = $height + 1;

      // width of one color step
      $step_red = $dif_red / $height;
      $step_green = $dif_green / $height;
      $step_blue = $dif_blue / $height;
      $width = $width - 1;
      
      
      for ($pos=0; $pos<=$height; $pos++)
      {
         $color = imagecolorexact ($image, $this->draw($red_start,$red_end,$pos,$step_red),
                                                                        $this->draw($green_start,$green_end,$pos,$step_green),
                                                                        $this->draw($blue_start,$blue_end,$pos,$step_blue));
         if ($color == -1) // If this color is already allocatated, don't allocate it again.
         {
                $color = ImageColorAllocate($image,$this->draw($red_start,$red_end,$pos,$step_red),
                                                                                $this->draw($green_start,$green_end,$pos,$step_green),
                                                                                $this->draw($blue_start,$blue_end,$pos,$step_blue));    
         }              
        imageline($image,$x1,$pos+$y1,$x1+$width,$pos+$y1,$color);
        
      }
      
   }

   function DrawBarGraph($image)
   {
      if ($this->_debug)
         $this->DebugPrint();

      // Setup the margins
      $this->_topMargin = 0;
      $this->_bottomMargin = 30;
      $this->_leftMargin = 20;
      $this->_rightMargin = $this->_barSpacing + 1 + 10;

      // setup the color for the lines
      $tempLineColor = $this->RGBColor($this->_lineColorHex);
      $lineColor = ImageColorAllocate($image, $tempLineColor["red"], $tempLineColor["green"], $tempLineColor["blue"]);

      $tempStartColor = $this->RGBColor($this->_startBarColorHex);
      $startColor = ImageColorAllocate($image, $tempStartColor["red"], $tempStartColor["green"], $tempStartColor["blue"]);

      // Figure out how wide each bar is going to be.
      $this->_barWidth = ($this->_width - ($this->_leftMargin + $this->_rightMargin + 1) - (count($this->_values) * $this->_barSpacing)) / count($this->_values);

      // Find out what the smallest and largest amount is.
      $this->_minBarHeight = $this->_values[0]["value"];
      $this->_maxBarHeight = $this->_values[0]["value"];
      for ($i=1; $i < count($this->_values); $i++)
      {
         if ($this->_minBarHeight > $this->_values[$i]["value"])
         {
            $this->_minBarHeight = $this->_values[$i]["value"];
         }
         if ($this->_maxBarHeight < $this->_values[$i]["value"])
         {
            $this->_maxBarHeight = $this->_values[$i]["value"];
         }
      }
      
      if ($this->_minBarHeight == 0 && $this->_maxBarHeight > 0) // Having the min value as 0 looks funny
      {
         $this->_minBarHeight = 1;
      }
      $buff = 1;
      // Figure out how tall the tallest and smallest bar are going to be.
      $this->_realMinBarHeight = $this->_minBarHeight - ($this->_minBarHeight * $buff + 1);
      $this->_realMaxBarHeight = $this->_maxBarHeight * ($this->_buffer + 1);
      $workArea = $this->_height - $this->_bottomMargin - $this->_topMargin - 1;

      // Print out all the ticks
      if ($this->_numOfValueTicks > $this->_maxBarHeight)
      {
         $this->_numOfValueTicks = $this->_maxBarHeight;
      }
      
      for ($i=1; $i<=$this->_numOfValueTicks; $i++)
      {
         $thisBarValue = floor((($this->_maxBarHeight - $this->_minBarHeight) / $this->_numOfValueTicks) * $i) + $this->_minBarHeight;
         $myTickheight = ($workArea / ($this->_maxBarHeight - $this->_realMinBarHeight) * ($thisBarValue - $this->_realMinBarHeight));

         // Figure out where we're going to put this tick..
         $y1 = $this->_height - $this->_bottomMargin - 1 - ($myTickheight);

         if ($thisBarValue >= $this->_minBarHeight)
         {
            imageline($image, $this->_leftMargin - 5 + $this->_x, $y1 + $this->_y,  $this->_width - $this->_rightMargin + $this->_barSpacing + $this->_x, $y1 + $this->_y, $lineColor);
            Imagestring($image, 1, $this->_leftMargin + $this->_x - 15, $y1 + $this->_y + 2, $thisBarValue, $lineColor);
         }
      }
      
      // Print out all the bars
      for ($i=1; $i<=count($this->_values); $i++)
      {
         // Get the bar height for this bar.
         $myBarheight = ($workArea / ($this->_maxBarHeight - $this->_realMinBarHeight) * ($this->_values[$i-1]["value"] - $this->_realMinBarHeight));
         
         // Figure out where we're going to put this bar..
         $x1 = $this->_leftMargin + 1 + (($i-1) * $this->_barWidth) + ($i * $this->_barSpacing);
         $y1 = $this->_height - $this->_bottomMargin - 1 - ($myBarheight);
         $x2 = $this->_leftMargin + (($i-1) * $this->_barWidth) + ($i * $this->_barSpacing) + $this->_barWidth;
         $y2 = $this->_height - $this->_bottomMargin - 1;
   
         if ($this->_values[$i-1]["value"] != 0) // Don't print a bar if the value is 0
         {
            // Print the bar
            if ($this->_showFade)
            {
               $this->fadeBar($image, $x1 + $this->_x, $y1 + $this->_y, $x2 + $this->_x, $y2 + $this->_y, $this->_startBarColorHex, $this->_endBarColorHex, $myBarheight, $this->_barWidth);
            }
            else
            {
               ImageFilledRectangle($image, $x1 + $this->_x, $y1 + $this->_y, $x2 + $this->_x, $y2 + $this->_y, $startColor);
            }
   
            if ($this->_showBarBorder)
            {
               ImageRectangle($image, $x1 + $this->_x, $y1 + $this->_y, $x2 + $this->_x, $y2 + $this->_y + 1, $lineColor);
            }
         }   
         // Print the amount of the bar
         if ($this->_showValues)
         {
            Imagestring($image, 2, $x1 + $this->_x, $this->_height-($this->_bottomMargin/2)-10 + $this->_y, $this->_values[$i-1]["value"], $lineColor); 
         }

         // Print out the label of the bar.
         if ($this->_showLabels)
         {
            Imagestring($image, 2, $x1 + $this->_x, $this->_height-($this->_bottomMargin/2) + $this->_y, $this->_values[$i-1]["label"], $lineColor); 
         }
      }

      // draw the border box
      if ($this->_showOuterBox)
      {
         ImageRectangle($image, $this->_leftMargin + $this->_x, $this->_topMargin + $this->_y, $this->_width - $this->_rightMargin + $this->_barSpacing + $this->_x, $this->_height - $this->_bottomMargin + $this->_y, $lineColor);
      }


       
   }
}


?>