adamjakab / SuiteCRM

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(""); }

modules/AOR_Fields/AOR_Field.php

Doc Comments +3 added lines

@@ -57,6 +57,9 @@
 		parent::Basic();
 	}
 
+    /**
+     * @param AOR_Report $parent
+     */
     function save_lines($post_data, $parent, $key = ''){
 
         require_once('modules/AOW_WorkFlow/aow_utils.php');

modules/AOR_Reports/AOR_Report.php

Doc Comments +12 added lines

@@ -322,6 +322,9 @@ 
         return $rows;
     }
 
+    /**
+     * @param string $body
+     */
     private function getMultiGroupFrameHTML($header, $body) {
         $html = '<div class="multi-group-list" style="border: 1px solid black; padding: 10px;">
                     <h3>' . $header . '</h3>
@@ -330,6 +333,9 @@ 
         return $html;
     }
 
+    /**
+     * @param string $html
+     */
     private function addDataIdValueToInnertext($html) {
         preg_match('/\sdata-id-value\s*=\s*"([^"]*)"/', $html, $match);
         $html = preg_replace('/(>)([^<]*)(<\/\w+>$)/', '$1$2' . $match[1] . '$3', $html);
@@ -920,6 +926,9 @@ 
 
     }
 
+    /**
+     * @param string $query_where
+     */
     private function queryWhereRepair($query_where) {
 
         // remove empty parenthesis and fix query syntax
@@ -1030,6 +1039,9 @@ 
     }
 
 
+    /**
+     * @param string $type
+     */
     function build_report_query_join($name, $alias, $parentAlias, SugarBean $module, $type, $query = array(),SugarBean $rel_module = null ){
 
         if(!isset($query['join'][$alias])){

modules/AOR_Reports/aor_utils.php

Doc Comments +3 added lines

@@ -88,6 +88,9 @@
     return $params;
 }
 
+/**
+ * @param SugarBean $report
+ */
 function getConditionsAsParameters($report, $override = array())
 {
     if (empty($report)) {

modules/AOR_Reports/views/view.edit.php

Doc Comments +4 added lines

@@ -138,6 +138,10 @@
         return $charts;
     }
 
+    /**
+     * @param string $modulePath
+     * @param string $field
+     */
     public function getDisplayForField($modulePath, $field, $reportModule){
         $modulePathDisplay = array();
         $currentBean = BeanFactory::getBean($reportModule);