adamjakab / SuiteCRM

modules/AOR_Charts/AOR_Chart.php

Doc Comments +73 added lines

@@ -56,6 +56,9 @@ 
 		parent::Basic();
 	}
 
+    /**
+     * @param string $postKey
+     */
     function save_lines(array $post,AOR_Report $bean,$postKey){
         $seenIds = array();
         if(isset($post[$postKey.'id'])) {
@@ -105,12 +108,23 @@ 
         return array('main'=>$main,'highlight'=>$highlight);
     }
 
+    /**
+     * @param pImage $chartPicture
+     */
     function buildChartImageBar($chartPicture,$recordImageMap = false){
         $scaleSettings = array("DrawSubTicks" => false, "LabelRotation" => 30, 'MinDivHeight' => 50);
         $chartPicture->drawScale($scaleSettings);
         $chartPicture->drawBarChart(array("RecordImageMap"=>$recordImageMap));
     }
 
+    /**
+     * @param pImage $chartPicture
+     * @param pData $chartData
+     * @param integer $imageHeight
+     * @param integer $imageWidth
+     * @param string $xName
+     * @param boolean $recordImageMap
+     */
     function buildChartImagePie($chartPicture,$chartData, $reportData,$imageHeight, $imageWidth, $xName,$recordImageMap){
         $PieChart = new pPie($chartPicture,$chartData);
         $x = 0;
@@ -122,12 +136,20 @@ 
         $PieChart->drawPieLegend($imageWidth*0.7,$imageHeight/3, array('FontSize'=>10,"FontName"=>"modules/AOR_Charts/lib/pChart/fonts/verdana.ttf",'BoxSize'=>14));
     }
 
+    /**
+     * @param pImage $chartPicture
+     */
     function buildChartImageLine($chartPicture, $recordImageMap = false){
         $scaleSettings = array("XMargin"=>10,"YMargin"=>10,"GridR"=>200,"GridG"=>200,"GridB"=>200,'MinDivHeight' => 50,"LabelRotation" => 30);
         $chartPicture->drawScale($scaleSettings);
         $chartPicture->drawLineChart(array("RecordImageMap"=>$recordImageMap));
     }
 
+    /**
+     * @param pImage $chartPicture
+     * @param pData $chartData
+     * @param boolean $recordImageMap
+     */
     function buildChartImageRadar($chartPicture, $chartData,$recordImageMap){
         $SplitChart = new pRadar();
         $Options = array("LabelPos"=>RADAR_LABELS_HORIZONTAL,"RecordImageMap"=>$recordImageMap);
@@ -303,6 +325,11 @@ 
         return $chart;
     }
 
+    /**
+     * @param string $chartDataValues
+     * @param string $chartLabelValues
+     * @param string $chartTooltips
+     */
     private function getRGraphRoseChart($chartDataValues, $chartLabelValues,$chartTooltips, $chartName= '', $chartId, $chartHeight = 400, $chartWidth = 400)
     {
         $dataArray = json_decode($chartDataValues);
@@ -340,6 +367,12 @@ 
     //I have not used a parameter for getRGraphBarChart to say whether to group etc, as the future development could be quite different
     //for both, hence the separate methods.  However, the $grouped parameter allows us to specify whether the chart is grouped (true)
     //or stacked (false)
+
+    /**
+     * @param string $chartDataValues
+     * @param string $chartLabelValues
+     * @param string $chartTooltips
+     */
     private function getRGraphGroupedBarChart($chartDataValues, $chartLabelValues,$chartTooltips, $chartName= '', $chartId, $chartHeight = 400, $chartWidth = 400, $grouped = false)
     {
         //$keys = array_keys($chartTooltips);
@@ -398,6 +431,11 @@ 
 
 
 
+    /**
+     * @param string $chartDataValues
+     * @param string $chartLabelValues
+     * @param string $chartTooltips
+     */
     private function getRGraphBarChart($chartDataValues, $chartLabelValues,$chartTooltips, $chartName= '', $chartId, $chartHeight = 400, $chartWidth = 400)
     {
         $dataArray = json_decode($chartDataValues);
@@ -437,6 +475,11 @@ 
         return $html;
     }
 
+    /**
+     * @param string $chartDataValues
+     * @param string $chartLabelValues
+     * @param string $chartTooltips
+     */
     private function getRGraphRadarChart($chartDataValues, $chartLabelValues,$chartTooltips, $chartName= '', $chartId, $chartHeight = 400, $chartWidth = 400)
     {
         $dataArray = json_decode($chartDataValues);
@@ -469,6 +512,11 @@ 
         return $html;
     }
 
+    /**
+     * @param string $chartDataValues
+     * @param string $chartLabelValues
+     * @param string $chartTooltips
+     */
     private function getRGraphPieChart($chartDataValues, $chartLabelValues,$chartTooltips, $chartName= '', $chartId, $chartHeight = 400, $chartWidth = 400)
     {
         $dataArray = json_decode($chartDataValues);
@@ -505,6 +553,11 @@ 
         return $html;
     }
 
+    /**
+     * @param string $chartDataValues
+     * @param string $chartLabelValues
+     * @param string $chartTooltips
+     */
     private function getRGraphLineChart($chartDataValues, $chartLabelValues,$chartTooltips, $chartName= '', $chartId, $chartHeight = 400, $chartWidth = 400)
     {
         $dataArray = json_decode($chartDataValues);
@@ -637,6 +690,10 @@ 
     }
 
 
+    /**
+     * @param string $xName
+     * @param string $yName
+     */
     private function getRGraphGroupedBarChartData($reportData, $xName,$yName, AOR_Field $mainGroupField){
 
 
@@ -706,6 +763,10 @@ 
 
     }
 
+    /**
+     * @param string $xName
+     * @param string $yName
+     */
     private function getRGraphBarChartData($reportData, $xName,$yName){
         $chart['labels']=array();
         $chart['data']=array();
@@ -753,6 +814,10 @@ 
         return '';
     }
 
+    /**
+     * @param string $xName
+     * @param string $yName
+     */
     private function getLineChartData($reportData, $xName,$yName){
         return $this->getBarChartData($reportData, $xName,$yName);
     }
@@ -778,10 +843,18 @@ 
         return $this->getBarChartConfig();
     }
 
+    /**
+     * @param string $xName
+     * @param string $yName
+     */
     private function getRadarChartData($reportData, $xName,$yName){
         return $this->getBarChartData($reportData, $xName,$yName);
     }
 
+    /**
+     * @param string $xName
+     * @param string $yName
+     */
     private function getPolarChartData($reportData, $xName,$yName){
         return $this->getPieChartData($reportData, $xName,$yName);
     }

modules/AOR_Charts/lib/pChart/class/pBarcode128.class.php

Doc Comments +4 added lines

@@ -179,6 +179,10 @@
 
    function left($value,$NbChar) { return substr($value,0,$NbChar); }  
    function right($value,$NbChar) { return substr($value,strlen($value)-$NbChar,$NbChar); }  
+
+   /**
+    * @param integer $NbChar
+    */
    function mid($value,$Depart,$NbChar) { return substr($value,$Depart-1,$NbChar); }  
   }
 ?>
\ No newline at end of file

modules/AOR_Charts/lib/pChart/class/pBarcode39.class.php

Doc Comments +8 added lines

@@ -181,6 +181,9 @@ 
       }
     }
 
+   /**
+    * @param string $string
+    */
    function checksum( $string )
     {
      $checksum = 0;
@@ -195,6 +198,11 @@ 
 
    function left($value,$NbChar) { return substr($value,0,$NbChar); }  
    function right($value,$NbChar) { return substr($value,strlen($value)-$NbChar,$NbChar); }  
+
+   /**
+    * @param integer $Depart
+    * @param integer $NbChar
+    */
    function mid($value,$Depart,$NbChar) { return substr($value,$Depart-1,$NbChar); }  
   }
 ?>
\ No newline at end of file

modules/AOR_Charts/lib/pChart/class/pCache.class.php

Doc Comments +3 added lines

@@ -235,6 +235,9 @@
      return(TRUE);
     }
 
+   /**
+    * @param string $Destination
+    */
    function saveFromCache($ID,$Destination)
     {
      /* Get the raw picture from the cache */

modules/AOR_Charts/lib/pChart/class/pData.class.php

Doc Comments +24 added lines

@@ -106,6 +106,10 @@ 
     }
 
    /* Strip VOID values */
+
+   /**
+    * @param string $Values
+    */
    function stripVOID($Values)
     { if (!is_array($Values)) { return(array()); } $Result = array(); foreach($Values as $Key => $Value) { if ( $Value != VOID ) { $Result[] = $Value; } } return($Result); }
 
@@ -188,6 +192,10 @@ 
     { $this->Data["XAxisUnit"] = $Unit; }
 
    /* Set the serie that will be used as abscissa */
+
+   /**
+    * @param string $Serie
+    */
    function setAbscissa($Serie)
     { if (isset($this->Data["Series"][$Serie])) { $this->Data["Abscissa"] = $Serie; } }
 
@@ -525,6 +533,10 @@ 
     }
 
    /* Load a palette file */
+
+   /**
+    * @param string $FileName
+    */
    function loadPalette($FileName,$Overwrite=FALSE)
     {
      if ( !file_exists($FileName) ) { return(-1); }
@@ -560,6 +572,10 @@ 
     }
 
    /* Initialise a given scatter serie */
+
+   /**
+    * @param integer $ID
+    */
    function initScatterSerie($ID)
     {
      if ( isset($this->Data["ScatterSeries"][$ID]) ) { return(0); }
@@ -582,6 +598,10 @@ 
     }
 
    /* Initialise a given serie */
+
+   /**
+    * @param string $Serie
+    */
    function initialise($Serie)
     {
      if ( isset($this->Data["Series"]) ) { $ID = count($this->Data["Series"]); } else { $ID = 0; }
@@ -782,6 +802,10 @@ 
     { return("pData object."); }
 
    function left($value,$NbChar)	{ return substr($value,0,$NbChar); }  
+
+   /**
+    * @param integer $NbChar
+    */
    function right($value,$NbChar)	{ return substr($value,strlen($value)-$NbChar,$NbChar); }  
    function mid($value,$Depart,$NbChar)	{ return substr($value,$Depart-1,$NbChar); }  
   }

modules/AOR_Charts/lib/pChart/class/pDraw.class.php

Doc Comments +44 added lines

@@ -124,6 +124,10 @@ 
     }
 
    /* Draw a polygon */
+
+   /**
+    * @param string $Points
+    */
    function drawPolygon($Points,$Format="")
     {
      $R			= isset($Format["R"]) ? $Format["R"] : 0;
@@ -573,6 +577,10 @@ 
     }
 
    /* Drawn a spline based on the bezier function */
+
+   /**
+    * @param string $Coordinates
+    */
    function drawSpline($Coordinates,$Format="")
     {
      $R		= isset($Format["R"]) ? $Format["R"] : 0;
@@ -1028,6 +1036,10 @@ 
     }
 
    /* Draw a gradient within a defined area */
+
+   /**
+    * @param integer $Direction
+    */
    function drawGradientArea($X1,$Y1,$X2,$Y2,$Direction,$Format="")
     {
      $StartR	= isset($Format["StartR"]) ? $Format["StartR"] : 90;
@@ -1109,6 +1121,11 @@ 
     }
 
    /* Draw an aliased pixel */
+
+   /**
+    * @param double $X
+    * @param double $Y
+    */
    function drawAntialiasPixel($X,$Y,$Format="")
     {
      $R     = isset($Format["R"]) ? $Format["R"] : 0;
@@ -1188,6 +1205,10 @@ 
     }
 
    /* Convert apha to base 10 */
+
+   /**
+    * @param integer $AlphaValue
+    */
    function convertAlpha($AlphaValue)
     { return((127/100)*(100-$AlphaValue)); }
 
@@ -1205,6 +1226,11 @@ 
     }
 
    /* Load a PNG file and draw it over the chart */
+
+   /**
+    * @param double $X
+    * @param double $Y
+    */
    function drawFromPNG($X,$Y,$FileName)
     { $this->drawFromPicture(1,$FileName,$X,$Y); }
 
@@ -2484,6 +2510,9 @@ 
       }
     }
 
+   /**
+    * @param integer $ID
+    */
    function isValidLabel($Value,$LastValue,$LabelingMethod,$ID,$LabelSkip)
     {
      if ( $LabelingMethod == LABELING_DIFFERENT && $Value != $LastValue ) { return(TRUE); }
@@ -2495,6 +2524,10 @@ 
     }
 
    /* Compute the scale, check for the best visual factors */
+
+   /**
+    * @param double $MaxDivs
+    */
    function computeScale($XMin,$XMax,$MaxDivs,$Factors,$AxisID=0)
     {
      /* Compute each factors */
@@ -2523,6 +2556,10 @@ 
     }
 
    /* Compute the best matching scale based on size & factors */
+
+   /**
+    * @param integer $AxisID
+    */
    function processScale($XMin,$XMax,$MaxDivs,$Factors,$AxisID)
     {
      $ScaleHeight = abs(ceil($XMax)-floor($XMin));
@@ -2603,6 +2640,9 @@ 
      return($Scale);
     }
 
+   /**
+    * @param double $Value2
+    */
    function modulo($Value1,$Value2)
     {
      if (floor($Value2) == 0) { return(0); }
@@ -5792,6 +5832,10 @@ 
     }
 
    /* Draw a label box */
+
+   /**
+    * @param string $Captions
+    */
    function drawLabelBox($X,$Y,$Title,$Captions,$Format="")
     {
      $NoTitle			= isset($Format["NoTitle"]) ? $Format["NoTitle"] : NULL;

modules/AOR_Charts/lib/pChart/class/pImage.class.php

Doc Comments +29 added lines

@@ -82,6 +82,12 @@ 
    var $LastChartLayout	= CHART_LAST_LAYOUT_REGULAR;	// Last layout : regular or stacked
 
    /* Class constructor */
+
+   /**
+    * @param integer $XSize
+    * @param integer $YSize
+    * @param pData $DataSet
+    */
    function pImage($XSize,$YSize,$DataSet=NULL,$TransparentBackground=FALSE)
     {
      $this->TransparentBackground = $TransparentBackground;
@@ -126,6 +132,13 @@ 
     }
 
    /* Set the graph area position */
+
+   /**
+    * @param integer $X1
+    * @param integer $Y1
+    * @param integer $X2
+    * @param integer $Y2
+    */
    function setGraphArea($X1,$Y1,$X2,$Y2)
     {
      if ( $X2 < $X1 || $X1 == $X2 || $Y2 < $Y1 || $Y1 == $Y2 ) { return(-1); }
@@ -145,6 +158,10 @@ 
     { return($this->YSize); }
 
    /* Render the picture to a file */
+
+   /**
+    * @param string $FileName
+    */
    function render($FileName)
     {
      if ( $this->TransparentBackground ) { imagealphablending($this->Picture,false); imagesavealpha($this->Picture,true); }
@@ -268,6 +285,10 @@ 
     { print_r($this->DataSet); }
 
    /* Initialise the image map methods */
+
+   /**
+    * @param integer $StorageMode
+    */
    function initialiseImageMap($Name="pChart",$StorageMode=IMAGE_MAP_STORAGE_SESSION,$UniqueID="imageMap",$StorageFolder="tmp")
     {
      $this->ImageMapIndex 		= $Name;
@@ -327,6 +348,10 @@ 
     }
 
    /* Replace the title of one image map serie */
+
+   /**
+    * @param string $OldTitle
+    */
    function replaceImageMapTitle($OldTitle, $NewTitle)
     {
      if ( $this->ImageMapStorageMode == NULL ) { return(-1); }
@@ -403,6 +428,10 @@ 
     }
 
    /* Dump the image map */
+
+   /**
+    * @param integer $StorageMode
+    */
    function dumpImageMap($Name="pChart",$StorageMode=IMAGE_MAP_STORAGE_SESSION,$UniqueID="imageMap",$StorageFolder="tmp")
     {
      $this->ImageMapIndex 		= $Name;

modules/AOR_Charts/lib/pChart/class/pPie.class.php

Doc Comments +26 added lines

@@ -697,6 +697,10 @@ 
     }
 
    /* Draw the legend of pie chart */
+
+   /**
+    * @param double $X
+    */
    function drawPieLegend($X,$Y,$Format="")
     {
      $FontName		= isset($Format["FontName"]) ? $Format["FontName"] : $this->pChartObject->FontName;
@@ -782,6 +786,10 @@ 
     }
 
    /* Set the color of the specified slice */
+
+   /**
+    * @param integer $SliceID
+    */
    function setSliceColor($SliceID,$Format="")
     {
      $R		= isset($Format["R"]) ? $Format["R"] : 0;
@@ -796,6 +804,13 @@ 
     }
 
    /* Internally used compute the label positions */
+
+   /**
+    * @param double $X
+    * @param double $Y
+    * @param double $Angle
+    * @param boolean $Stacked
+    */
    function writePieLabel($X,$Y,$Label,$Angle,$Settings,$Stacked,$Xc=0,$Yc=0,$Radius=0,$Reversed=FALSE)
     {
      $LabelOffset	= 30;
@@ -847,6 +862,13 @@ 
     }
 
    /* Internally used to shift label positions */
+
+   /**
+    * @param integer $StartAngle
+    * @param integer $EndAngle
+    * @param double $Offset
+    * @param boolean $Reversed
+    */
    function shift($StartAngle,$EndAngle,$Offset,$Reversed)
     {
      if ( $Reversed ) { $Offset = -$Offset; }
@@ -1462,6 +1484,10 @@ 
    }
 
   /* Reverse an array */
+
+  /**
+   * @param string $Plots
+   */
   function arrayReverse($Plots)
    {
     $Result = "";

modules/AOR_Charts/lib/pChart/class/pSpring.class.php

Doc Comments +9 added lines

@@ -258,6 +258,11 @@ 
      $this->Data[$SourceID]["Connections"][] = $TargetID;
     }
    /* Get the median linked nodes position */
+
+   /**
+    * @param double $X
+    * @param double $Y
+    */
    function getMedianOffset($Key,$X,$Y)
     {
      $Cpt = 1;
@@ -277,6 +282,10 @@ 
     }
 
    /* Return the ID of the attached partner with the biggest weight */
+
+   /**
+    * @return double
+    */
    function getBiggestPartner($Key)
     {
      if ( !isset($this->Data[$Key]["Connections"]) ) { return(""); }