Enalean / tuleap

plugins/projectlinks/include/ProjectLinksPluginInfo.class.php

Doc Comments +3 added lines

@@ -28,6 +28,9 @@
 
 class ProjectLinksPluginInfo extends PluginInfo {
     
+    /**
+     * @param ProjectLinksPlugin $plugin
+     */
     function ProjectLinksPluginInfo(&$plugin) {
         $this->PluginInfo($plugin);
         $this->setPluginDescriptor(new ProjectLinksPluginDescriptor());

plugins/statistics/include/ProjectQuotaHtml.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -266,7 +266,7 @@
      * @param String $sortBy             Order result set according to this parameter
      * @param String $orderBy            Specifiy if the result set sort is ascending or descending
      * @param String $projectFilterParam Search filter
-     * @param Array  $list               List of projects Id corresponding to a given filter
+     * @param Iterator  $list               List of projects Id corresponding to a given filter
      *
      * @return Array
      */

plugins/statistics/include/ProjectQuotaManager.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -51,7 +51,7 @@ 
      *
      * @param Integer $group_id The ID of the project we are looking for its quota
      *
-     * @return String
+     * @return integer
      */
     private function getProjectAuthorizedQuota($group_id) {
         $quota = $this->getProjectCustomQuota($group_id);
@@ -66,7 +66,7 @@ 
      *
      * @param Integer $size The quota size in bi
      *
-     * @return Float
+     * @return integer
      */
     private function convertQuotaToGiB($size) {
         return $size * 1024 * 1024 * 1024;

plugins/statistics/include/ProjectsOverQuotaTablePresenter.class.php

Doc Comments +3 added lines

@@ -22,6 +22,9 @@
 
     public $table_content;
 
+    /**
+     * @param string $table_content
+     */
     public function __construct($table_content) {
         $this->table_content  = $table_content;
     }

plugins/statistics/include/Statistics_DiskUsageDao.class.php

Doc Comments +20 added lines, -2 removed lines

@@ -58,6 +58,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $date
+     */
     public function findFirstDateGreaterEqualThan($date, $table) {
         $date = $this->da->quoteSmart($date);
         $sql  = "SELECT date
@@ -75,6 +78,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $table
+     */
     public function findFirstDateGreaterThan($date, $table, $field='date') {
         $sql = 'SELECT date'.
                ' FROM '.$table.
@@ -89,6 +95,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $table
+     */
     public function findFirstDateLowerThan($date, $table, $field='date') {
         $sql = 'SELECT date'.
                ' FROM '.$table.
@@ -139,6 +148,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param string $dateMethod
+     */
     protected function _getGroupByFromDateMethod($dateMethod, &$select, &$groupBy) {
         switch ($dateMethod) {
             case 'DAY':
@@ -291,7 +303,7 @@ 
      /**
      * Compute average size of user_id
      * 
-     * @param int $user_id
+     * @param int $userId
      * 
      * @return DataAccessResult
      */
@@ -362,7 +374,6 @@ 
     /**
      * Compute average size of user_id
      * 
-     * @param int $user_id
      * 
      * @return DataAccessResult
      */
@@ -457,6 +468,9 @@ 
     
     }
 
+    /**
+     * @param string $threshold_date
+     */
     public function purgeDataOlderThan($dates_to_keep, $threshold_date, $table) {
         $dates_to_keep  = $this->da->quoteSmartImplode(',', $dates_to_keep);
         $threshold_date = $this->da->quoteSmart($threshold_date);
@@ -468,6 +482,10 @@ 
         return $this->update($sql);
     }
 
+    /**
+     * @param string $threshold_date_min
+     * @param string $threshold_date_max
+     */
     public function purgeDataBetweenTwoDates($dates_to_keep, $threshold_date_min, $threshold_date_max, $table) {
         $dates_to_keep      = $this->da->quoteSmartImplode(',', $dates_to_keep);
         $threshold_date_min = $this->da->quoteSmart($threshold_date_min);

plugins/statistics/include/Statistics_DiskUsageHtml.class.php

Doc Comments +1 added lines

@@ -173,6 +173,7 @@
 
     /**
      * Apply a jpgraph compliant color modifier on color and return a css rgb() rule
+     * @param string $color
      */
     function applyColorModifier($color) {
         $jpgraphRgb = new RGB();

plugins/statistics/include/Statistics_DiskUsageManager.class.php

Doc Comments +35 added lines

@@ -176,6 +176,9 @@ 
         }
     }
 
+    /**
+     * @param string $groupBy
+     */
     function getRangeDates($dar, $groupBy) {
         $dates = array();
         foreach ($dar as $row) {
@@ -202,6 +205,9 @@ 
          
     }
 
+    /**
+     * @param integer $limit
+     */
     public function getTopProjects($startDate, $endDate, $service, $order, $offset, $limit) {
         $dao   = $this->_getDao();
         $dar   = $dao->getProjectContributionForService($startDate, $endDate, $service, $order, $offset, $limit);
@@ -340,6 +346,9 @@ 
         return false;
     }
 
+    /**
+     * @return integer
+     */
     public function returnTotalProjectSize($group_id){
         $dao  = $this->_getDao();
         $recentDate = $dao->searchMostRecentDate();
@@ -423,6 +432,10 @@ 
         return false;
     }
 
+    /**
+     * @param integer $groupId
+     * @param string $groupBy
+     */
     public function getWeeklyEvolutionProjectTotalSize($groupId,$groupBy, $startDate, $endDate){
         $groupBy = strtoupper($groupBy);
         $dao  = $this->_getDao();
@@ -437,6 +450,9 @@ 
          
     }
 
+    /**
+     * @param integer $userId
+     */
     public function getWeeklyEvolutionUserData($userId,$groupBy, $startDate, $endDate){
         $groupBy = strtoupper($groupBy);
         $dao  = $this->_getDao();
@@ -451,6 +467,10 @@ 
          
     }
     
+    /**
+     * @param integer $groupId
+     * @param string $groupBy
+     */
     public function getWeeklyEvolutionProjectData($services, $groupId,$groupBy, $startDate, $endDate){
         $groupBy = strtoupper($groupBy);
         $dao  = $this->_getDao();
@@ -478,6 +498,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $dir
+     */
     public function getDirSize($dir) {
         if (is_dir($dir)) {
             $output = array();
@@ -490,6 +513,10 @@ 
         return false;
     }
     
+    /**
+     * @param string $service
+     * @param string $path
+     */
     public function storeForGroup($groupId, $service, $path) {
         $size = $this->getDirSize($path.'/');
         if ($size) {
@@ -498,6 +525,10 @@ 
         }
     }
 
+    /**
+     * @param string $service
+     * @param string $path
+     */
     public function storeForUser($userId, $service, $path) {
         $size = $this->getDirSize($path.'/');
         if ($size) {
@@ -506,6 +537,10 @@ 
         }
     }
     
+    /**
+     * @param string $service
+     * @param string $path
+     */
     public function storeForSite($service, $path) {
         $size = $this->getDirSize($path.'/');
         if ($size) {

plugins/statistics/include/Statistics_Services_UsageFormatter.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -73,7 +73,7 @@
     /**
      * Format a query result containing size to put them in MegaBytes
      *
-     * @param array|DataAccessResult $query_result
+     * @param array|DataAccessResult $query_results
      */
     public function formatSizeInMegaBytes($query_results) {
         $resized_results = array();

plugins/statistics/include/Statistics_ServicesUsageDao.class.php

Doc Comments +3 added lines

@@ -150,6 +150,9 @@
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $timestamp
+     */
     private function formatDateForCVS($timestamp) {
         return strftime("%Y%m%d", $timestamp);
     }