Enalean / tuleap

plugins/tracker/include/Tracker/Artifact/dao/Tracker_Artifact_Changeset_ValueDao.class.php

Doc Comments +20 added lines

@@ -26,6 +26,9 @@ 
         $this->table_name = 'tracker_changeset_value';
     }
      
+    /**
+     * @param integer $id
+     */
     public function searchById($id) {
         $id = $this->da->escapeInt($id);
         $sql = "SELECT * FROM $this->table_name
@@ -33,6 +36,10 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $changeset_id
+     * @param integer $field_id
+     */
     public function searchByFieldId($changeset_id, $field_id) {
         $changeset_id = $this->da->escapeInt($changeset_id);
         $field_id = $this->da->escapeInt($field_id);
@@ -42,6 +49,11 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $changeset_id
+     * @param integer $field_id
+     * @param integer $has_changed
+     */
     public function save($changeset_id, $field_id, $has_changed) {
         $changeset_id = $this->da->escapeInt($changeset_id);
         $field_id = $this->da->escapeInt($field_id);
@@ -51,6 +63,11 @@ 
         return $this->updateAndGetLastId($sql);
     }    
 
+    /**
+     * @param integer $tracker_id
+     * @param integer $field_id
+     * @param integer $has_changed
+     */
     public function createFromLastChangesetByTrackerId($tracker_id, $field_id, $has_changed) {
         $tracker_id  = $this->da->escapeInt($tracker_id);
         $field_id    = $this->da->escapeInt($field_id);
@@ -84,6 +101,9 @@ 
         return $changesetValueIds;
     }
     
+    /**
+     * @param integer $changeset_id
+     */
     public function delete($changeset_id) {
         $changeset_id = $this->da->escapeInt($changeset_id);
         $sql = "DELETE

plugins/tracker/include/Tracker/Artifact/dao/Tracker_Artifact_ChangesetDao.class.php

Doc Comments +15 added lines

@@ -25,6 +25,9 @@ 
         $this->table_name = 'tracker_changeset';
     }   
 
+    /**
+     * @param integer $artifact_id
+     */
     public function searchByArtifactId($artifact_id) {
         $artifact_id = $this->da->escapeInt($artifact_id);
         $sql = "SELECT * FROM $this->table_name
@@ -33,6 +36,10 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $artifact_id
+     * @param integer $changeset_id
+     */
     public function searchByArtifactIdAndChangesetId($artifact_id, $changeset_id) {
         $artifact_id = $this->da->escapeInt($artifact_id);
         $changeset_id = $this->da->escapeInt($changeset_id);
@@ -42,6 +49,11 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $artifact_id
+     * @param integer $submitted_by
+     * @param string|null $email
+     */
     public function create($artifact_id, $submitted_by, $email, $submitted_on) {
         $artifact_id  = $this->da->escapeInt($artifact_id);
         $submitted_by = $this->da->escapeInt($submitted_by);
@@ -61,6 +73,9 @@ 
         return $changeset_id;
     }
     
+    /**
+     * @param integer $changeset_id
+     */
     public function delete($changeset_id) {
         $changeset_id = $this->da->escapeInt($changeset_id);
         $sql = "DELETE

plugins/tracker/include/Tracker/Artifact/dao/Tracker_Artifact_PriorityHistoryDao.class.php

Doc Comments +10 added lines

@@ -21,6 +21,10 @@ 
  */
 class Tracker_Artifact_PriorityHistoryDao extends DataAccessObject {
 
+    /**
+     * @param integer $priority_updated_by
+     * @param integer $priority_updated_on
+     */
     public function logPriorityChange($moved_artifact_id, $artifact_higher_id, $artifact_lower_id, $context_id, $project_id, $priority_updated_by, $priority_updated_on, $old_global_rank) {
         $moved_artifact_id   = $this->da->escapeInt($moved_artifact_id);
         $artifact_higher_id  = $this->da->escapeInt($artifact_higher_id);
@@ -39,6 +43,9 @@ 
         $this->update($sql);
     }
 
+    /**
+     * @param integer $artifact_id
+     */
     public function getArtifactPriorityHistory($artifact_id) {
         $artifact_id  = $this->da->escapeInt($artifact_id);
 
@@ -49,6 +56,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $artifact_id
+     */
     public function deletePriorityChangesHistory($artifact_id) {
         $artifact_id  = $this->da->escapeInt($artifact_id);
 

plugins/tracker/include/Tracker/Artifact/dao/Tracker_ArtifactDao.class.php

Doc Comments +85 added lines

@@ -28,6 +28,9 @@ 
         $this->table_name = 'tracker_artifact';
     }
 
+    /**
+     * @param integer $id
+     */
     public function searchById($id) {
         $id      = $this->da->escapeInt($id);
         $sql = "SELECT *
@@ -36,6 +39,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $tracker_id
+     */
     public function searchByTrackerId($tracker_id) {
         $tracker_id = $this->da->escapeInt($tracker_id);
         $sql = "SELECT A.*, CVT.value AS title
@@ -49,6 +55,11 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $tracker_id
+     * @param integer $limit
+     * @param integer $offset
+     */
     public function searchPaginatedByTrackerId($tracker_id, $limit, $offset, $reverse_order) {
         $tracker_id = $this->da->escapeInt($tracker_id);
         $limit      = $this->da->escapeInt($limit);
@@ -70,6 +81,7 @@ 
 
     /**
      * @param string $artifact_ids "2,14,15"
+     * @param boolean $user_is_admin
      */
     public function searchLastChangesetIds($artifact_ids, array $ugroups, $user_is_admin) {
         $artifact_ids = $this->da->escapeIntImplode(explode(',', $artifact_ids));
@@ -288,6 +300,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $tracker_id
+     */
     public function searchStatsForTracker($tracker_id) {
         $tracker_id = $this->da->escapeInt($tracker_id);
         $sql = "SELECT R1.t AS last_creation, R2.t AS last_update, R3.t as nb_total, R4.t as nb_open
@@ -313,6 +328,10 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $start_date
+     * @param integer $end_date
+     */
     public function searchSubmittedArtifactBetweenTwoDates($start_date, $end_date) {
         $start_date = $this->da->escapeInt($start_date);
         $end_date   = $this->da->escapeInt($end_date);
@@ -326,6 +345,10 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $start_date
+     * @param integer $end_date
+     */
     public function searchClosedArtifactBetweenTwoDates($start_date, $end_date) {
         $start_date = $this->da->escapeInt($start_date);
         $end_date   = $this->da->escapeInt($end_date);
@@ -349,6 +372,11 @@ 
         return $this->da->quoteSmart('%'. $keyword .'%');
     }
 
+    /**
+     * @param integer $tracker_id
+     * @param string $criteria
+     * @param integer $limit
+     */
     public function searchByKeywords($tracker_id, $keywords, $criteria, $offset, $limit) {
         $tracker_id = $this->da->escapeInt($tracker_id);
         $criteria   = $criteria === 'OR' ? 'OR' : 'AND'; //make sure that the request is not forged
@@ -375,6 +403,11 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $tracker_id
+     * @param integer $submitted_by
+     * @param integer $use_artifact_permissions
+     */
     public function create($tracker_id, $submitted_by, $submitted_on, $use_artifact_permissions) {
         $tracker_id               = $this->da->escapeInt($tracker_id);
         $use_artifact_permissions = $this->da->escapeInt($use_artifact_permissions);
@@ -404,6 +437,11 @@ 
         return false;
     }
 
+    /**
+     * @param integer $id
+     * @param integer $tracker_id
+     * @param boolean $use_artifact_permissions
+     */
     public function save($id, $tracker_id, $use_artifact_permissions) {
         $id                       = $this->da->escapeInt($id);
         $tracker_id               = $this->da->escapeInt($tracker_id);
@@ -416,11 +454,17 @@ 
         return $this->update($sql);
     }
 
+    /**
+     * @param integer $id
+     */
     public function delete($id) {
         $sql = "DELETE FROM $this->table_name WHERE id = ". $this->da->escapeInt($id);
         return $this->update($sql);
     }
 
+    /**
+     * @param integer $id
+     */
     public function deleteArtifactLinkReference($id) {
         $dao = new Tracker_FormElement_Field_Value_ArtifactLinkDao();
         return $dao->deleteReference($id);
@@ -475,6 +519,7 @@ 
 
     /**
      * It does not check permissions
+     * @param integer $artifact_id
      */
     public function getChildren($artifact_id) {
         return $this->getChildrenForArtifacts(array($artifact_id));
@@ -482,6 +527,7 @@ 
 
     /**
      * It does not check permissions
+     * @param integer $artifact_id
      */
     public function getPaginatedChildren($artifact_id, $limit, $offset) {
         return $this->getPaginatedChildrenForArtifacts(array($artifact_id), $limit, $offset);
@@ -505,6 +551,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param string $artifact_ids
+     */
     private function getFromStatementForChildrenOfArtifacts($artifact_ids) {
         return " FROM tracker_artifact parent_art
                      INNER JOIN tracker_field                        f          ON (f.tracker_id = parent_art.tracker_id AND f.formElement_type = 'art_link' AND use_it = 1)
@@ -531,6 +580,9 @@ 
     }
 
 
+    /**
+     * @param integer $artifact_id
+     */
     public function getSiblings($artifact_id) {
         $artifact_id = $this->da->escapeInt($artifact_id);
         $sql = "SELECT art_sibling.*
@@ -614,6 +666,9 @@ 
         return $this->getLinkedArtifactsByIds(array($artifact_id));
     }
 
+    /**
+     * @param integer $artifact_id
+     */
     public function getLinkedOpenArtifactsOfTrackersNotLinkedToOthers($artifact_id, array $tracker_ids, array $excluded_linked_ids, $additional_artifacts = '') {
         $artifact_id  = $this->da->escapeInt($artifact_id);
         $tracker_ids  = $this->da->escapeIntImplode($tracker_ids);
@@ -671,6 +726,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $artifact_id
+     */
     public function getLinkedArtifactsOfTrackersNotLinkedToOthers($artifact_id, array $tracker_ids, array $excluded_linked_ids, $additional_artifacts = '') {
         $artifact_id  = $this->da->escapeInt($artifact_id);
         $tracker_ids  = $this->da->escapeIntImplode($tracker_ids);
@@ -718,6 +776,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $artifact_id
+     */
     public function getLinkedArtifactsOfTrackersConcatenatedToCustomList($artifact_id, array $tracker_ids, $additional_artifacts = '') {
         $artifact_id  = $this->da->escapeInt($artifact_id);
         $tracker_ids  = $this->da->escapeIntImplode($tracker_ids);
@@ -813,6 +874,9 @@ 
         return $this->retrieveFirstRow($sql);
     }
 
+    /**
+     * @param integer $artifact_id
+     */
     public function getLinkedArtifactsOfTrackersWithLimitAndOffset($artifact_id, array $tracker_ids, $limit, $offset) {
         $artifact_id = $this->da->escapeInt($artifact_id);
         $tracker_ids = $this->da->escapeIntImplode($tracker_ids);
@@ -834,6 +898,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $artifact_id
+     */
     public function getLinkedOpenArtifactsOfTrackersNotLinkedToOthersWithLimitAndOffset($artifact_id, array $tracker_ids, array $excluded_linked_ids, $additional_artifacts = '', $limit, $offset) {
         $artifact_id  = $this->da->escapeInt($artifact_id);
         $tracker_ids  = $this->da->escapeIntImplode($tracker_ids);
@@ -884,6 +951,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $artifact_id
+     */
     public function getLinkedArtifactsOfTrackersNotLinkedToOthersWithLimitAndOffset($artifact_id, array $tracker_ids, array $excluded_linked_ids, $additional_artifacts = '', $limit, $offset) {
         $artifact_id  = $this->da->escapeInt($artifact_id);
         $tracker_ids  = $this->da->escapeIntImplode($tracker_ids);
@@ -1006,6 +1076,9 @@ 
         return array();
     }
 
+    /**
+     * @param integer $artifact_id
+     */
     public function getUnsubscribersIds($artifact_id) {
         $artifact_id = $this->da->escapeInt($artifact_id);
         $sql = "SELECT user_id
@@ -1015,6 +1088,10 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $artifact_id
+     * @param integer $user_id
+     */
     public function doesUserHaveUnsubscribedFromNotifications($artifact_id, $user_id) {
         $artifact_id = $this->da->escapeInt($artifact_id);
         $user_id     = $this->da->escapeInt($user_id);
@@ -1027,6 +1104,10 @@ 
         return $this->retrieve($sql)->count() > 0;
     }
 
+    /**
+     * @param integer $artifact_id
+     * @param integer $user_id
+     */
     public function createUnsubscribeNotification($artifact_id, $user_id) {
         $artifact_id = $this->da->escapeInt($artifact_id);
         $user_id     = $this->da->escapeInt($user_id);
@@ -1037,6 +1118,10 @@ 
         $this->update($sql);
     }
 
+    /**
+     * @param integer $artifact_id
+     * @param integer $user_id
+     */
     public function deleteUnsubscribeNotification($artifact_id, $user_id) {
         $artifact_id = $this->da->escapeInt($artifact_id);
         $user_id     = $this->da->escapeInt($user_id);

plugins/tracker/include/Tracker/Artifact/MailGateway/MailGateway.class.php

Doc Comments +3 added lines

@@ -80,6 +80,9 @@
         $this->incoming_mail_dao        = $incoming_mail_dao;
     }
 
+    /**
+     * @param string $raw_mail
+     */
     public function process($raw_mail) {
         $raw_mail_parsed = $this->parser->parse($raw_mail);
         try {

plugins/tracker/include/Tracker/Artifact/Presenter/ArtifactLinkPresenter.php

Doc Comments +6 added lines

@@ -27,6 +27,12 @@
 
     public $title;
 
+    /**
+     * @param string $tracker_name
+     * @param integer $group_id
+     * @param integer $artifact_id
+     * @param string $title
+     */
     public function __construct(
         $tracker_name,
         $group_id,

plugins/tracker/include/Tracker/Artifact/Presenter/CreateArtifactInPlacePresenter.php

Doc Comments +4 added lines

@@ -31,6 +31,10 @@
     /** @var bool */
     private $render_with_javascript;
 
+    /**
+     * @param Tracker_Artifact|null $artifact_to_link
+     * @param string $form_elements
+     */
     public function __construct(Tracker $tracker, $artifact_to_link, $form_elements, $render_with_javascript) {
         $this->tracker                = $tracker;
         $this->artifact_to_link       = $artifact_to_link;

plugins/tracker/include/Tracker/Artifact/Presenter/EditArtifactInPlacePresenter.php

Doc Comments +5 added lines

@@ -39,6 +39,11 @@
     /** @var PFUser */
     private $user;
 
+    /**
+     * @param string $follow_ups
+     * @param Tracker_Artifact_Presenter_ArtifactLinkPresenter[] $artifact_links
+     * @param string $form_elements
+     */
     public function __construct(
         $follow_ups,
         $artifact_links,

plugins/tracker/include/Tracker/Artifact/Renderer/EditInPlaceRenderer.class.php

Doc Comments +6 added lines

@@ -48,6 +48,9 @@ 
         $this->renderer->renderToPage('artifact-modal', $presenter);
     }
 
+    /**
+     * @param Codendi_Request $request
+     */
     public function getSubmittedValues($request) {
         $submitted_values = array(0 => null);
 
@@ -144,6 +147,9 @@ 
         return $fields_data;
     }
 
+    /**
+     * @param string $exception_message
+     */
     private function sendErrorsAsJson($exception_message) {
         $feedback            = array();
         $feedback['message'] = $exception_message;