Enalean / tuleap

plugins/tracker/include/Tracker/DateReminder/Tracker_DateReminder.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -68,7 +68,7 @@
     /**
      * Get reminder id
      *
-     * @return String
+     * @return integer
      */
     public function getId() {
         return $this->reminderId;

plugins/tracker/include/Tracker/DateReminder/Tracker_DateReminder_Role_Assignee.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
      *
      * @param Tracker_Artifact $artifact
      *
-     * @return Array of PFUser
+     * @return PFUser[] of PFUser
      */
     function getRecipientsFromArtifact(Tracker_Artifact $artifact) {
         $permission_assignee = new Tracker_Permission_PermissionRetrieveAssignee($artifact->getUserManager());

plugins/tracker/include/Tracker/DateReminder/Tracker_DateReminderManager.class.php

Doc Comments +2 added lines

@@ -235,6 +235,8 @@
      * Get the subject for reminder
      *
      * @param String $recipient The recipient who will receive the reminder
+     * @param Tracker_DateReminder $reminder
+     * @param Tracker_Artifact $artifact
      *
      * @return String
      */

plugins/tracker/include/Tracker/DateReminder/Tracker_DateReminderRenderer.class.php

Doc Comments +2 added lines, -1 removed lines

@@ -140,6 +140,7 @@ 
      * It contains: all dynamic ugroups plus project members and admins and the defined tracker roles
      *
      * @params Integer $reminderId Id of the date reminder we want to customize its notified
+     * @param integer $reminderId
      *
      * @return String
      */
@@ -406,7 +407,7 @@ 
     /**
      * Display all reminders of the tracker
      *
-     * @return Void
+     * @return string|null
      */
     public function displayAllReminders() {
         $titles           = array($GLOBALS['Language']->getText('plugin_tracker_date_reminder','tracker_date_reminder_send_to'),

plugins/tracker/include/Tracker/FormElement/dao/Tracker_FormElement_Field_List_Bind_Static_ValueDao.class.php

Doc Comments +27 added lines

@@ -66,6 +66,11 @@ 
         return $this->updateAndGetLastId($sql);
     }
 
+    /**
+     * @param string $label
+     * @param string $description
+     * @param string $rank
+     */
     public function create($field_id, $label, $description, $rank, $is_hidden) {
         $field_id     = $this->da->escapeInt($field_id);
         $label        = $this->da->quoteSmart($label);
@@ -92,6 +97,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $id
+     */
     public function hideValue($id) {
         $id  = $this->da->escapeInt($id);
 
@@ -103,6 +111,9 @@ 
         return $this->update($sql);
     }
 
+    /**
+     * @param integer $id
+     */
     public function updateLabel($id, $label) {
         $id    = $this->da->escapeInt($id);
         $label = $this->da->quoteSmart($label);
@@ -133,6 +144,9 @@ 
         return $this->update($sql);
     }
 
+    /**
+     * @param integer $id
+     */
     public function delete($id) {
         $id       = $this->da->escapeInt($id);
         $sql = "DELETE FROM $this->table_name
@@ -157,6 +171,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $value_id
+     */
     public function canValueBeHiddenWithoutCheckingSemanticStatus($field_id, $value_id) {
         $semantic_status_statement = '';
 
@@ -245,6 +262,9 @@ 
         return ! isset($this->cache_canbehidden_values[$field_id][$value_id]);
     }
 
+    /**
+     * @param integer $value_id
+     */
     public function canValueBeDeleted($field_id, $value_id) {
         $field_id = $this->da->escapeInt($field_id);
         $value_id = $this->da->escapeInt($value_id);
@@ -274,6 +294,9 @@ 
         return $this->canValueBeHidden($field_id, $value_id) && ! isset($this->cache_canbedeleted_values[$field_id][$value_id]);
     }
 
+    /**
+     * @param integer $field_id
+     */
     public function updateOriginalValueId($field_id, $old_original_value_id, $new_original_value_id) {
         $field_id              = $this->da->escapeInt($field_id);
         $old_original_value_id = $this->da->escapeInt($old_original_value_id);
@@ -304,6 +327,10 @@ 
         return $this->update($sql);
     }
 
+    /**
+     * @param integer $field_id
+     * @param string $label
+     */
     public function searchValueByLabel($field_id, $label) {
         $field_id = $this->da->escapeInt($field_id);
         $label    = $this->da->quoteSmart($label);

plugins/tracker/include/Tracker/FormElement/dao/Tracker_FormElement_Field_List_Bind_Ugroups_ValueDao.class.php

Doc Comments +12 added lines

@@ -64,6 +64,9 @@ 
         return $this->updateAndGetLastId($sql);
     }
 
+    /**
+     * @param boolean $is_hidden
+     */
     public function create($field_id, $ugroup_id, $is_hidden) {
         $field_id  = $this->da->escapeInt($field_id);
         $ugroup_id = $this->da->escapeInt($ugroup_id);
@@ -74,14 +77,23 @@ 
         return $this->updateAndGetLastId($sql);
     }
 
+    /**
+     * @param integer $id
+     */
     public function hide($id) {
         return $this->toggleHidden($id, 1);
     }
 
+    /**
+     * @param integer $id
+     */
     public function show($id) {
         return $this->toggleHidden($id, 0);
     }
 
+    /**
+     * @param integer $is_hidden
+     */
     private function toggleHidden($id, $is_hidden) {
         $id        = $this->da->escapeInt($id);
         $is_hidden = $is_hidden ? 1 : 0;

plugins/tracker/include/Tracker/FormElement/dao/Tracker_FormElement_Field_List_Bind_UsersDao.class.php

Doc Comments +8 added lines

@@ -23,6 +23,10 @@ 
         parent::__construct();
         $this->table_name = 'tracker_field_list_bind_users';
     }
+
+    /**
+     * @param integer $field_id
+     */
     public function searchByFieldId($field_id) {
         $field_id  = $this->da->escapeInt($field_id);
         $sql = "SELECT *
@@ -47,6 +51,10 @@ 
         return $this->update($sql);
     }
     
+    /**
+     * @param string $display_name_query
+     * @param string $display_name_order
+     */
     public function searchChangesetValues($changeset_id, $field_id, $display_name_query, $display_name_order) {
         $changeset_id = $this->da->escapeInt($changeset_id);
         $field_id     = $this->da->escapeInt($field_id);

plugins/tracker/include/Tracker/FormElement/dao/Tracker_FormElement_Field_List_BindDecoratorDao.class.php

Doc Comments +4 added lines

@@ -23,6 +23,10 @@
         parent::__construct();
         $this->table_name = 'tracker_field_list_bind_decorator';
     }
+
+    /**
+     * @param integer $field_id
+     */
     public function searchByFieldId($field_id) {
         $field_id  = $this->da->escapeInt($field_id);
         $sql = "SELECT *

plugins/tracker/include/Tracker/FormElement/dao/Tracker_FormElement_Field_List_OpenValueDao.class.php

Doc Comments +17 added lines

@@ -23,6 +23,10 @@ 
         parent::__construct();
         $this->table_name = 'tracker_field_openlist_value';
     }
+
+    /**
+     * @param integer $field_id
+     */
     public function searchById($field_id, $id) {
         $field_id  = $this->da->escapeInt($field_id);
         $id        = $this->da->escapeInt($id);
@@ -33,6 +37,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $field_id
+     */
     public function searchByFieldId($field_id) {
         $field_id  = $this->da->escapeInt($field_id);
 
@@ -53,6 +60,10 @@ 
         return $this->update($sql);
     }
     
+    /**
+     * @param integer $field_id
+     * @param string $label
+     */
     public function create($field_id, $label) {
         $field_id = $this->da->escapeInt($field_id);
         $label    = $this->da->quoteSmart($label);
@@ -61,6 +72,9 @@ 
         return $this->updateAndGetLastId($sql);
     }
     
+    /**
+     * @param integer $field_id
+     */
     public function searchByKeyword($field_id, $keyword, $limit = 10) {
         $field_id = $this->da->escapeInt($field_id);
         $limit = $this->da->escapeInt($limit);
@@ -73,6 +87,9 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $field_id
+     */
     public function searchByExactLabel($field_id, $label) {
         $field_id = $this->da->escapeInt($field_id);
         $label    = $this->da->quoteSmart($label);