Enalean / tuleap

plugins/tracker/include/Tracker/CannedResponse/dao/Tracker_CannedResponseDao.class.php

Doc Comments +18 added lines

@@ -24,6 +24,10 @@ 
         $this->table_name = 'tracker_canned_response';
     }
     
+    /**
+     * @param integer $tracker_id
+     * @param integer $id
+     */
     public function searchById($tracker_id, $id) {
         $tracker_id = $this->da->escapeInt($tracker_id);
         $id = $this->da->escapeInt($id);
@@ -34,6 +38,9 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $tracker_id
+     */
     public function searchByTrackerId($tracker_id) {
         $tracker_id = $this->da->escapeInt($tracker_id);
         $sql = "SELECT * 
@@ -43,6 +50,11 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $tracker_id
+     * @param string $title
+     * @param string $body
+     */
     public function create($tracker_id, $title, $body) {
         $tracker_id = $this->da->escapeInt($tracker_id);
         $title      = $this->da->quoteSmart($title);
@@ -52,6 +64,9 @@ 
         return $this->updateAndGetLastId($sql);
     }
     
+    /**
+     * @param Tracker_CannedResponse $canned
+     */
     public function save($canned) {
         $id         = $this->da->escapeInt($canned->id);
         $title      = $this->da->quoteSmart($canned->title);
@@ -63,6 +78,9 @@ 
         return $this->update($sql);
     }
     
+    /**
+     * @param integer $id
+     */
     public function delete($id) {
         $id = $this->da->escapeInt($id);
         $sql = "DELETE FROM $this->table_name 

plugins/tracker/include/Tracker/CannedResponse/Tracker_CannedResponseFactory.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -35,7 +35,7 @@ 
     /**
      * The singleton method
      *
-     * @return Tracker_ResponseFactory An instance of canned response factory
+     * @return Tracker_CannedResponseFactory An instance of canned response factory
      */
     public static function instance() {
         if (!isset(self::$instance)) {
@@ -92,7 +92,7 @@ 
      * @param Tracker $tracker the tracker
      * @param int     $id      the id of the canned response
      *
-     * @return CannedResponse or null if not found
+     * @return Tracker_CannedResponse|null or null if not found
      */
     public function getCannedResponse($tracker, $id) {
         $response = null;

plugins/tracker/include/Tracker/CannedResponse/Tracker_CannedResponseManager.class.php

Doc Comments +8 added lines

@@ -20,10 +20,18 @@
 
 class Tracker_CannedResponseManager {
     protected $tracker;
+
+    /**
+     * @param Tracker $tracker
+     */
     public function __construct($tracker) {
         $this->tracker = $tracker;
     }
     
+    /**
+     * @param Codendi_Request $request
+     * @param PFUser $current_user
+     */
     public function process(TrackerManager $tracker_manager, $request, $current_user) {
         if ($request->get('create')) {
             if ($request->existAndNonEmpty('title') && $request->existAndNonEmpty('body')) {

plugins/tracker/include/Tracker/CardPresenter.class.php

Doc Comments +8 added lines

@@ -30,6 +30,7 @@ 
 
     /**
      * @var string
+     * @return string
      */
     public function getTitle();
     
@@ -40,26 +41,31 @@ 
 
     /**
      * @var string
+     * @return string
      */
     public function getUrl();
 
     /**
      * @var string
+     * @return string
      */
     public function getXRef();
 
     /**
      * @var string
+     * @return string
      */
     public function getEditUrl();
 
     /**
      * @var string
+     * @return integer
      */
     public function getArtifactId();
 
     /**
      * @var int
+     * @return integer
      */
     public function getAncestorId();
 
@@ -75,11 +81,13 @@ 
 
     /**
      * @var string
+     * @return string
      */
     public function getCssClasses();
 
     /**
      * @var array of Tracker
+     * @return Tracker[]
      */
     public function allowedChildrenTypes();
 

plugins/tracker/include/Tracker/Chart/Burndown.class.php

Doc Comments +3 added lines

@@ -53,6 +53,9 @@
         $this->start_date = round($start_date / self::SECONDS_IN_A_DAY);
     }
     
+    /**
+     * @param integer $start_date
+     */
     public function setStartDateInDays($start_date) {
         $this->start_date = $start_date;
     }

plugins/tracker/include/Tracker/Chart/Data/Burndown.class.php

Doc Comments +3 added lines

@@ -149,6 +149,9 @@
         return $value !== null;
     }
 
+    /**
+     * @param integer $i
+     */
     private function getIdealEffortAtDay($i, $start_effort) {
         if ($start_effort !== null) {
             return floatval(($this->getDuration() - $i) * ($start_effort / $this->getDuration()));

plugins/tracker/include/Tracker/dao/Tracker_FileInfoDao.class.php

Doc Comments +10 added lines

@@ -57,6 +57,13 @@ 
         return false;
     }
 
+    /**
+     * @param integer $submitted_by
+     * @param string $description
+     * @param string $filename
+     * @param integer $filesize
+     * @param string $filetype
+     */
     public function create($submitted_by, $description, $filename, $filesize, $filetype) {
         $submitted_by = $this->da->escapeInt($submitted_by);
         $description  = $this->da->quoteSmart($description);
@@ -85,6 +92,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $id
+     */
     public function searchArtifactIdByFileInfoId($id) {
         $id = $this->da->escapeInt($id);
         $sql = "SELECT DISTINCT c.artifact_id as artifact_id, cv.field_id as field_id

plugins/tracker/include/Tracker/dao/Tracker_PermDao.class.php

Doc Comments +15 added lines

@@ -25,6 +25,9 @@ 
         $this->table_name = 'tracker_perm';
     }
 
+    /**
+     * @param integer $tracker_id
+     */
     function searchByUserIdAndTrackerId($user_id, $tracker_id) {
         $user_id      = $this->da->escapeInt($user_id);
         $tracker_id      = $this->da->escapeInt($tracker_id);
@@ -36,6 +39,9 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $tracker_id
+     */
     function updateUser($user_id, $perm_level, $tracker_id) {
         $user_id        = $this->da->escapeInt($user_id);
         $perm_level     = $this->da->escapeInt($perm_level);
@@ -48,6 +54,9 @@ 
         return $this->update($sql);
     }
     
+    /**
+     * @param integer $tracker_id
+     */
     function createUser($user_id, $perm_level, $tracker_id) {
         $user_id = $this->da->escapeInt($user_id);
         $perm_level = $this->da->escapeInt($perm_level);
@@ -59,6 +68,9 @@ 
         return $this->update($sql);
     }
     
+    /**
+     * @param integer $tracker_id
+     */
     function deleteUser($user_id, $tracker_id) {
         $user_id    = $this->da->escapeInt($user_id);
         $tracker_id = $this->da->escapeInt($tracker_id);
@@ -67,6 +79,9 @@ 
         return $this->update($sql);
     }
     
+    /**
+     * @param integer $tracker_id
+     */
     function searchAccessPermissionsByTrackerId($tracker_id) {
         $tracker_id = $this->da->escapeInt($tracker_id);
         

plugins/tracker/include/Tracker/dao/TrackerDao.class.php

Doc Comments +24 added lines, -1 removed lines

@@ -67,7 +67,7 @@ 
     * Check if the shortname of the tracker is already used in the project
     * @param string $item_name the shortname of the tracker we are looking for
     * @param int $group_id the ID of the group
-    * @return boolean
+    * @return integer
     */
     public function isShortNameExists($item_name, $group_id) {
         $item_name = $this->da->quoteSmart($item_name);
@@ -107,6 +107,13 @@ 
         }
     }
 
+    /**
+     * @param integer $atid_template
+     * @param Project $group_id
+     * @param string $name
+     * @param string $description
+     * @param string $item_name
+     */
     function duplicate($atid_template, $group_id, $name, $description, $item_name) {
         $atid_template = $this->da->escapeInt($atid_template);
         $group_id      = $this->da->escapeInt($group_id);
@@ -155,6 +162,19 @@ 
         return false;
     }
 
+    /**
+     * @param integer $group_id
+     * @param string $name
+     * @param string $description
+     * @param string $item_name
+     * @param integer $allow_copy
+     * @param string $status
+     * @param string $deletion_date
+     * @param integer $instantiate_for_new_projects
+     * @param integer $log_priority_changes
+     * @param string $color
+     * @param integer $enable_emailgateway
+     */
     function create(
         $group_id,
         $name,
@@ -277,6 +297,9 @@ 
         return $this->update($sql);
     }
 
+    /**
+     * @param string $restriction_clause
+     */
     private function restrict($restriction_clause, $excluded_tracker_ids) {
         if (!$excluded_tracker_ids) {
             return "";