Enalean / tuleap

plugins/agiledashboard/include/AgileDashboard/AgileDashboardController.class.php

Doc Comments +3 added lines

@@ -131,6 +131,9 @@
         );
     }
 
+    /**
+     * @param string $root_planning_name
+     */
     private function getPlanningAdminPresenterList(PFUser $user, $group_id, $root_planning_name) {
         $plannings                 = array();
         $planning_out_of_hierarchy = array();

plugins/agiledashboard/include/AgileDashboard/AgileDashboardStatisticsAggregator.class.php

Doc Comments +21 added lines

@@ -35,6 +35,9 @@ 
         $this->event_manager = EventManager::instance();
     }
 
+    /**
+     * @param string $type
+     */
     private function addHit($project_id, $type) {
         $params = array(
             'project_id'     => $project_id,
@@ -43,22 +46,37 @@ 
         $this->event_manager->processEvent('aggregate_statistics', $params);
     }
 
+    /**
+     * @param integer $project_id
+     */
     public function addCardDragAndDropHit($project_id) {
         $this->addHit($project_id, self::CARD_DRAG_AND_DROP);
     }
 
+    /**
+     * @param integer $project_id
+     */
     public function addExpandCollapseColumnHit($project_id) {
         $this->addHit($project_id, self::EXPAND_COLLAPSE_COLUMN);
     }
 
+    /**
+     * @param integer $project_id
+     */
     public function addWIPModificationHit($project_id) {
         $this->addHit($project_id, self::WIP_MODIFICATION);
     }
 
+    /**
+     * @param integer $project_id
+     */
     public function addKanbanRenamingHit($project_id) {
         $this->addHit($project_id, self::KANBAN_RENAMING);
     }
 
+    /**
+     * @param integer $project_id
+     */
     public function addKanbanAddInPlaceHit($project_id) {
         $this->addHit($project_id, self::KANBAN_ADD_IN_PLACE);
     }
@@ -73,6 +91,9 @@ 
         return $res;
     }
 
+    /**
+     * @param string $statistic_name
+     */
     public function getStatistics($statistic_name, $date_start, $date_end) {
         $statistics_data = array();
         $params = array(

plugins/agiledashboard/include/AgileDashboard/BacklogItem/PaginatedBacklogItemsRepresentationsBuilder.class.php

Doc Comments +8 added lines

@@ -43,6 +43,8 @@ 
     }
 
     /**
+     * @param integer $limit
+     * @param integer $offset
      * @return AgileDashboard_BacklogItem_PaginatedBacklogItemsRepresentations;
      */
     public function getPaginatedBacklogItemsRepresentationsForMilestone(PFUser $user, Planning_Milestone $milestone, $limit, $offset) {
@@ -60,6 +62,9 @@ 
         return $this->getBacklogItemsRepresentations($user, $top_milestone, $strategy);
     }
 
+    /**
+     * @param AgileDashboard_Milestone_Backlog_DescendantBacklogStrategy $strategy
+     */
     private function getBacklogItemsRepresentations(PFUser $user, Planning_Milestone $milestone, $strategy) {
         $backlog_items                 = $this->getMilestoneBacklogItems($user, $milestone, $strategy);
         $backlog_items_representations = array();
@@ -71,6 +76,9 @@ 
         return new AgileDashboard_BacklogItem_PaginatedBacklogItemsRepresentations($backlog_items_representations, $backlog_items->getTotalAvaialableSize());
     }
 
+    /**
+     * @param Planning_Milestone $milestone
+     */
     private function getMilestoneBacklogItems(PFUser $user, $milestone, $strategy) {
         return $this->backlog_item_collection_factory->getUnplannedOpenCollection($user, $milestone, $strategy, false);
     }

plugins/agiledashboard/include/AgileDashboard/BacklogItem/SubBacklogItemProvider.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -98,7 +98,7 @@
      * We need to keep list of ids we already looked at so we avoid cycles.
      *
      * @param int $backlog_tracker_id
-     * @param array $artifacts
+     * @param integer[] $artifacts
      */
     private function filterBacklogIds($backlog_tracker_id, array $artifacts) {
         $artifacts_to_inspect = array();

plugins/agiledashboard/include/AgileDashboard/KanbanColumnDao.class.php

Doc Comments +8 added lines

@@ -33,6 +33,10 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $kanban_id
+     * @param integer $column_id
+     */
     public function setColumnWipLimit($kanban_id, $column_id, $wip_limit) {
         $kanban_id = $this->da->escapeInt($kanban_id);
         $column_id = $this->da->escapeInt($column_id);
@@ -44,6 +48,10 @@ 
         return $this->update($sql);
     }
 
+    /**
+     * @param integer $kanban_id
+     * @param integer $column_id
+     */
     public function deleteColumn($kanban_id, $column_id) {
         $kanban_id = $this->da->escapeInt($kanban_id);
         $column_id = $this->da->escapeInt($column_id);

plugins/agiledashboard/include/AgileDashboard/KanbanColumnFactory.php

Doc Comments +3 added lines

@@ -89,6 +89,9 @@
         throw new AgileDashboard_KanbanColumnNotFoundException($kanban, $column_id);
     }
 
+    /**
+     * @param Tracker_FormElement_Field_List_BindValue[] $field_values
+     */
     private function instantiate(AgileDashboard_Kanban $kanban, $id, PFUser $user, $field_values) {
         return new AgileDashboard_KanbanColumn(
             $id,

plugins/agiledashboard/include/AgileDashboard/KanbanColumnManager.php

Doc Comments +9 added lines

@@ -40,6 +40,9 @@ 
         $this->kanban_actions_checker                       = $kanban_actions_checker;
     }
 
+    /**
+     * @param string $label
+     */
     public function createColumn(PFUser $user, AgileDashboard_Kanban $kanban, $label) {
         $this->kanban_actions_checker->checkUserCanAddColumns($user, $kanban);
 
@@ -81,12 +84,18 @@ 
         return true;
     }
 
+    /**
+     * @param integer $wip_limit
+     */
     public function updateWipLimit(PFUser $user, AgileDashboard_Kanban $kanban, AgileDashboard_KanbanColumn $column, $wip_limit) {
         $this->kanban_actions_checker->checkUserCanAdministrate($user, $kanban);
 
         return $this->column_dao->setColumnWipLimit($column->getKanbanId(), $column->getId(), $wip_limit);
     }
 
+    /**
+     * @param string $label
+     */
     public function updateLabel(PFUser $user, AgileDashboard_Kanban $kanban, AgileDashboard_KanbanColumn $column, $label) {
         $this->kanban_actions_checker->checkUserCanAdministrate($user, $kanban);
         $this->kanban_actions_checker->checkUserCanEditColumnLabel($user, $kanban);

plugins/agiledashboard/include/AgileDashboard/KanbanDao.class.php

Doc Comments +10 added lines

@@ -77,6 +77,10 @@ 
         return $this->updateAndGetLastId($sql);
     }
 
+    /**
+     * @param integer $kanban_id
+     * @param string $kanban_name
+     */
     public function save($kanban_id, $kanban_name) {
         $kanban_id   = $this->da->escapeInt($kanban_id);
         $kanban_name = $this->da->quoteSmart($kanban_name);
@@ -88,6 +92,9 @@ 
         return $this->update($sql);
     }
 
+    /**
+     * @param string $kanban_id
+     */
     public function delete($kanban_id) {
         $kanban_id   = $this->da->escapeInt($kanban_id);
 
@@ -106,6 +113,9 @@ 
         $this->commit();
     }
 
+    /**
+     * @param integer $tracker_kanban
+     */
     public function getKanbanByTrackerId($tracker_kanban) {
         $tracker_kanban = $this->da->escapeInt($tracker_kanban);
 

plugins/agiledashboard/include/AgileDashboard/KanbanItemDao.class.php

Doc Comments +28 added lines, -1 removed lines

@@ -21,6 +21,9 @@ 
 
 class AgileDashboard_KanbanItemDao extends DataAccessObject {
 
+    /**
+     * @param integer $tracker_id
+     */
     public function getAllKanbanItemIds($tracker_id) {
         $tracker_id = $this->da->escapeInt($tracker_id);
 
@@ -34,6 +37,7 @@ 
 
     /**
      * Backlog items for a kanban are artifacts that have no value for the semantic status field
+     * @param integer $tracker_id
      */
     public function searchPaginatedBacklogItemsByTrackerId($tracker_id, $limit, $offset) {
         $tracker_id = $this->da->escapeInt($tracker_id);
@@ -82,6 +86,7 @@ 
 
     /**
      * Archived items for a kanban are artifacts that have "closed" value for the semantic status field
+     * @param integer $tracker_id
      */
     public function searchPaginatedArchivedItemsByTrackerId($tracker_id, $limit, $offset) {
         $tracker_id = $this->da->escapeInt($tracker_id);
@@ -132,6 +137,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $tracker_id
+     */
     public function searchPaginatedItemsInColumn($tracker_id, $column_id, $limit, $offset) {
         $tracker_id = $this->da->escapeInt($tracker_id);
         $column_id  = $this->da->escapeInt($column_id);
@@ -177,6 +185,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $tracker_id
+     */
     public function getOpenItemIds($tracker_id) {
         $tracker_id = $this->da->escapeInt($tracker_id);
 
@@ -197,6 +208,10 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $tracker_id
+     * @param integer $item_id
+     */
     public function searchTimeInfoForItem($tracker_id, $item_id) {
         $tracker_id = $this->da->escapeInt($tracker_id);
         $item_id    = $this->da->escapeInt($item_id);
@@ -234,7 +249,7 @@ 
      * then goes back to Done column at t4, and finally come back at t5.
      * The returned value is expected to be t5.
      *
-     * @param type $item_id The archived item id
+     * @param integer $item_id The archived item id
      *
      * @return int|null
      */
@@ -268,6 +283,10 @@ 
         return is_array($row) ? (int)$row['submitted_on'] : null;
     }
 
+    /**
+     * @param integer $tracker_id
+     * @param integer $artifact_id
+     */
     public function isKanbanItemInBacklog($tracker_id, $artifact_id) {
         $tracker_id  = $this->da->escapeInt($tracker_id);
         $artifact_id = $this->da->escapeInt($artifact_id);
@@ -290,6 +309,10 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $tracker_id
+     * @param integer $artifact_id
+     */
     public function isKanbanItemInArchive($tracker_id, $artifact_id) {
         $tracker_id  = $this->da->escapeInt($tracker_id);
         $artifact_id = $this->da->escapeInt($artifact_id);
@@ -314,6 +337,10 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $tracker_id
+     * @param integer $artifact_id
+     */
     public function getColumnIdOfKanbanItem($tracker_id, $artifact_id) {
         $tracker_id  = $this->da->escapeInt($tracker_id);
         $artifact_id = $this->da->escapeInt($artifact_id);