Enalean / tuleap

plugins/agiledashboard/include/Planning/MilestoneFactory.class.php

Doc Comments +16 added lines, -10 removed lines

@@ -102,6 +102,8 @@ 
     }
 
     /**
+     * @param integer $offset
+     * @param integer $number_to_fetch
      * @return array of Planning_Milestone (the last $number_to_fetch open ones for the given $planning)
      */
     public function getLastOpenMilestones(PFUser $user, Planning $planning, $offset, $number_to_fetch) {
@@ -132,7 +134,7 @@ 
      * @param  PFUser $user
      * @param  Integer $artifact_id
      *
-     * @return Planning_Milestone|null
+     * @return Planning_ArtifactMilestone|null
      */
     public function getBareMilestoneByArtifactId(PFUser $user, $artifact_id) {
         $artifact = $this->artifact_factory->getArtifactById($artifact_id);
@@ -148,7 +150,7 @@ 
      * @param  PFUser $user
      * @param  Integer $artifact_id
      *
-     * @return Planning_Milestone|null
+     * @return null|Planning_ArtifactMilestone
      */
     public function getValidatedBareMilestoneByArtifactId(PFUser $user, $artifact_id) {
         $artifact = $this->artifact_factory->getArtifactById($artifact_id);
@@ -164,7 +166,7 @@ 
     /**
      * @param PFUser $user
      * @param Tracker_Artifact $artifact
-     * @return Planning_Milestone|null
+     * @return Planning_ArtifactMilestone|null
      */
     public function getBareMilestoneByArtifact(PFUser $user, Tracker_Artifact $artifact) {
         $tracker  = $artifact->getTracker();
@@ -297,10 +299,9 @@ 
      * Retrieves the artifacts planned for the given milestone artifact.
      *
      * @param PFUser             $user
-     * @param Planning         $planning
      * @param Tracker_Artifact $milestone_artifact
      *
-     * @return TreeNode
+     * @return null|ArtifactNode
      */
     public function getPlannedArtifacts(PFUser             $user,
                                         Tracker_Artifact $milestone_artifact) {
@@ -315,12 +316,12 @@ 
     /**
      * Adds $parent_node children according to $artifact ones.
      *
-     * @param type $user
-     * @param type $artifact
-     * @param type $parent_node
+     * @param PFUser $user
+     * @param Tracker_Artifact $artifact
+     * @param TreeNode $parent_node
      * @param type $parents     The list of parents to prevent infinite recursion
      *
-     * @return boolean
+     * @return false|null
      */
     private function addChildrenPlannedArtifacts(PFUser             $user,
                                                  Tracker_Artifact $artifact,
@@ -337,6 +338,10 @@ 
         }
     }
 
+    /**
+     * @param PFUser $user
+     * @param Tracker_Artifact $artifact
+     */
     private function makeNodeWithChildren($user, $artifact, $parents) {
         $node = new ArtifactNode($artifact);
         $this->addChildrenPlannedArtifacts($user, $artifact, $node, $parents);
@@ -599,7 +604,7 @@ 
     /**
      * Create Milestones corresponding to an array of artifacts
      *
-     * @param Tracker_Artifact[] $artifact
+     * @param Tracker_Artifact[] $artifacts
      *
      * @return Planning_ArtifactMilestone[]
      */
@@ -741,6 +746,7 @@ 
     /**
      * Returns the last $quantity milestones - ordered by oldest first
      *
+     * @param integer $quantity
      * @return Planning_Milestone[]
      */
     public function getPastMilestones(PFUser $user, Planning $planning, $quantity) {

plugins/agiledashboard/include/Planning/MilestonePaneFactory.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -103,7 +103,7 @@
         return $this->active_pane[$milestone->getArtifactId()];
     }
 
-    /** @return AgileDashboard_PaneInfo[] */
+    /** @return AgileDashboard_PaneInfo */
     public function getListOfPaneInfo(Planning_Milestone $milestone) {
         if (! isset($this->list_of_pane_info[$milestone->getArtifactId()])) {
             $this->buildListOfPaneInfo($milestone);

plugins/agiledashboard/include/Planning/MilestonePresenter.class.php

Doc Comments +7 added lines, -1 removed lines

@@ -51,6 +51,9 @@ 
      */
     private $presenter_data;
 
+    /**
+     * @param string $planning_redirect_to_new
+     */
     public function __construct(
             Planning_Milestone $milestone,
             PFUser $current_user,
@@ -111,7 +114,7 @@ 
     }
 
     /**
-     * @return array
+     * @return AgileDashboard_PaneInfo[]
      */
     public function getPaneInfoList() {
         return $this->presenter_data->getListOfPaneInfo();
@@ -140,6 +143,9 @@ 
         return $start_date && $end_date;
     }
 
+    /**
+     * @param integer $date
+     */
     private function formatDate($date) {
         return date($GLOBALS['Language']->getText('system', 'datefmt_day_and_month'), $date);
     }

plugins/agiledashboard/include/Planning/MilestoneRedirectParameter.class.php

Doc Comments +2 added lines, -1 removed lines

@@ -32,7 +32,8 @@
         return "planning[$pane_identifier][$planning_id]=$artifact_id";
     }
 
-    /** @return string */
+    /** @param string $pane_identifier
+/** @return string */
     public function getPlanningRedirectToNew(Planning_Milestone $milestone, $pane_identifier) {
         $planning_id = (int) $milestone->getPlanningId();
 

plugins/agiledashboard/include/Planning/Planning.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -149,7 +149,7 @@ 
     }
     
     /**
-     * @param Tracker[] $backlog_tracker The trackers used as a backlog
+     * @param Tracker[] $backlog_trackers The trackers used as a backlog
      */
     public function setBacklogTrackers(array $backlog_trackers) {
         $this->backlog_trackers = $backlog_trackers;
@@ -163,7 +163,7 @@ 
     }
     
     /**
-     * @return Tracker
+     * @return Tracker[]
      */
     public function getBacklogTrackers() {
         return $this->backlog_trackers;

plugins/agiledashboard/include/Planning/PlanningController.class.php

Doc Comments +4 added lines

@@ -69,6 +69,9 @@ 
     /** @var AgileDashboard_HierarchyChecker */
     private $hierarchy_checker;
 
+    /**
+     * @param string $plugin_path
+     */
     public function __construct(
         Codendi_Request $request,
         PlanningFactory $planning_factory,
@@ -196,6 +199,7 @@ 
     }
 
     /**
+     * @param Planning[] $plannings
      * @return Planning_Presenter_MilestoneAccessPresenter
      */
     private function getMilestoneAccessPresenters($plannings) {

plugins/agiledashboard/include/Planning/PlanningDao.class.php

Doc Comments +18 added lines

@@ -28,6 +28,9 @@ 
         return new TrackerDao();
     }
     
+    /**
+     * @param integer $group_id
+     */
     function createPlanning($group_id, PlanningParameters $planning_parameters) {
         $planning_name       = $this->da->quoteSmart($planning_parameters->name);
         $backlog_title       = $this->da->quoteSmart($planning_parameters->backlog_title);
@@ -56,6 +59,9 @@ 
         $this->update($sql);
     }
     
+    /**
+     * @param integer $group_id
+     */
     function searchPlannings($group_id){
         $group_id = $this->da->escapeInt($group_id);
         $sql = "SELECT * 
@@ -90,6 +96,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $backlog_tracker_id
+     */
     public function searchByBacklogTrackerId($backlog_tracker_id) {
         $backlog_tracker_id = $this->da->escapeInt($backlog_tracker_id);
         $sql = "
@@ -153,6 +162,9 @@ 
         return $ids;
     }
     
+    /**
+     * @param integer $group_id
+     */
     public function searchNonPlanningTrackersByGroupId($group_id) {
         $planning_tracker_ids = $this->searchPlanningTrackerIdsByGroupId($group_id);
         $tracker_dao          = $this->getTrackerDao();
@@ -160,6 +172,9 @@ 
         return $tracker_dao->searchByGroupIdWithExcludedIds($group_id, $planning_tracker_ids);
     }
     
+    /**
+     * @param integer $planning_id
+     */
     function updatePlanning($planning_id, PlanningParameters $planning_parameters) {
         $planning_id         = $this->da->escapeInt($planning_id);
         $planning_name       = $this->da->quoteSmart($planning_parameters->name);
@@ -178,6 +193,9 @@ 
         $this->updateBacklogTrackers($planning_id, $planning_parameters);
     }
 
+    /**
+     * @param string $planning_id
+     */
     private function updateBacklogTrackers($planning_id, PlanningParameters $planning_parameters) {
         $this->deletePlanningBacklogTrackers($planning_id);
         $this->createBacklogTrackers($planning_id, $planning_parameters);

plugins/agiledashboard/include/Planning/PlanningFactory.class.php

Doc Comments +7 added lines, -5 removed lines

@@ -86,6 +86,9 @@ 
         }
     }
 
+    /**
+     * @param integer $group_id
+     */
     protected function duplicatePriorityChangePermission($group_id, $source_planning_id, $new_planning_id, array $ugroups_mapping) {
         $source_planning                       = $this->getPlanning($source_planning_id);
         $priority_change_permission_ugroup_ids = $this->planning_permissions_manager->getGroupIdsWhoHasPermissionOnPlanning(
@@ -284,7 +287,6 @@ 
      *
      * @param PFUser $user     The user who will see the planning
      * @param int  $group_id
-     * @param PlanningFactory $planning_factory
      *
      * @return Planning[]
      */
@@ -338,7 +340,6 @@ 
      *
      * @param PFUser $user     The user who will see the planning
      * @param int  $group_id
-     * @param PlanningFactory $planning_factory
      *
      * @return Planning[]
      */
@@ -378,7 +379,6 @@ 
     /**
      * Get a planning
      *
-     * @param int $group_id
      *
      * @return Planning
      */
@@ -548,6 +548,9 @@ 
         return $this->dao->searchPlanningTrackerIdsByGroupId($group_id);
     }
 
+    /**
+     * @param integer $group_id
+     */
     public function getBacklogTrackerIdsByGroupId($group_id) {
         return $this->dao->searchBacklogTrackerIdsByGroupId($group_id);
     }
@@ -592,7 +595,7 @@ 
      *
      * @param $planning_id the id of the planning
      *
-     * @return bool
+     * @return boolean|null
      */
     public function deletePlanning($planning_id) {
         return $this->dao->deletePlanning($planning_id);
@@ -617,7 +620,6 @@ 
     /**
      * Retrieve the project trackers that can be used as planning trackers.
      *
-     * @param Planning $planning The planning for which we want to know the available trackers.
      *
      * @return Array of Tracker
      */

plugins/agiledashboard/include/Planning/PlanningPermissionsManager.class.php

Doc Comments +5 added lines

@@ -22,6 +22,11 @@
 
     const PERM_PRIORITY_CHANGE = 'PLUGIN_AGILEDASHBOARD_PLANNING_PRIORITY_CHANGE';
 
+    /**
+     * @param integer $planning_id
+     * @param integer $group_id
+     * @param string $html_element_name
+     */
     public function getPlanningPermissionForm($planning_id, $group_id, $permission, $html_element_name) {
         return permission_fetch_selection_field($permission, $planning_id, $group_id, $html_element_name);
     }