Enalean / tuleap

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);

Unused Use Statements -2 removed lines

@@ -17,8 +17,6 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
-use Tuleap\AgileDashboard\REST\v1\Kanban\KanbanColumnPATCHRepresentation;
-
 class AgileDashboard_KanbanColumnManager {
 
     /** @var AgileDashboard_KanbanColumnDao */

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);

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

Doc Comments +5 added lines

@@ -41,6 +41,11 @@
     /** @var string */
     public $nodejs_server;
 
+    /**
+     * @param boolean $user_is_kanban_admin
+     * @param string $language
+     * @param integer $project_id
+     */
     public function __construct(
         AgileDashboard_Kanban $kanban,
         PFUser $user,

plugins/agiledashboard/include/AgileDashboard/Milestone/Backlog/BacklogItemCollectionFactory.class.php

Doc Comments +15 added lines

@@ -108,6 +108,9 @@ 
         return $this->done_collection[$milestone->getArtifactId()];
     }
 
+    /**
+     * @param false|string $redirect_to_self
+     */
     public function getUnassignedOpenCollection(
         PFUser $user,
         Planning_Milestone $milestone,
@@ -119,6 +122,9 @@ 
         return $this->filterOutAssignedBacklogItems($collection, $user);
     }
 
+    /**
+     * @param boolean $redirect_to_self
+     */
     public function getUnassignedCollection(
         PFUser $user,
         Planning_Milestone $milestone,
@@ -221,6 +227,9 @@ 
         return $collection;
     }
 
+    /**
+     * @param string $redirect_to_self
+     */
     public function getInconsistentCollection(
         PFUser $user,
         Planning_Milestone $milestone,
@@ -232,6 +241,9 @@ 
         return $this->inconsistent_collection[$milestone->getArtifactId()];
     }
 
+    /**
+     * @param string $redirect_to_self
+     */
     public function getAllCollection(
         PFUser $user,
         Planning_Milestone $milestone,
@@ -471,6 +483,9 @@ 
         }
     }
 
+    /**
+     * @param integer $artifact_id
+     */
     private function pushItemInDoneCollection(Planning_Milestone $milestone, array $semantics, $artifact_id, AgileDashboard_Milestone_Backlog_IBacklogItem $backlog_item) {
         $this->setInitialEffort($backlog_item, $semantics[$artifact_id]);
 

plugins/agiledashboard/include/AgileDashboard/Milestone/Backlog/BacklogRowPresenter.class.php

Doc Comments +9 added lines

@@ -24,12 +24,21 @@
 
 interface AgileDashboard_Milestone_Backlog_BacklogRowPresenter {
 
+    /**
+     * @return string
+     */
     public function title();
 
     public function url();
 
+    /**
+     * @return integer
+     */
     public function points();
 
+    /**
+     * @return string|null
+     */
     public function parent_title();
 
     public function parent_url();

plugins/agiledashboard/include/AgileDashboard/Milestone/Backlog/DescendantItemsFinder.class.php

Doc Comments +5 added lines

@@ -275,6 +275,7 @@ 
      * We only want the section of the tree that goes from a
      * tracker in a milestone to a tracker in a submilestone.
      *
+     * @param integer[] $submilestone_tracker_hierarchy_tree
      */
     private function extractRelevantSubmilestoneBacklogTrackerHierarchyTreeSection(&$submilestone_tracker_hierarchy_tree) {
         foreach ($submilestone_tracker_hierarchy_tree as $key => $value) {
@@ -299,6 +300,7 @@ 
 
     /**
      * get all children of a given type of any of the parent items
+     * @param string $ids_of_parent_items_to_search_in
      */
     private function getIdsOfChildItemsOfOneTrackerType($ids_of_parent_items_to_search_in, $tracker_id) {
         $search = $this->artifact_dao->getLinkedArtifactsOfArtifactsOfTrackerTypeAsString(
@@ -309,6 +311,9 @@ 
         return (string) $search['artifact_ids'];
     }
 
+    /**
+     * @param string $children
+     */
     private function canChildrenBePlanned($children, $tracker_id) {
         return $children && in_array($tracker_id, $this->descendant_tracker_ids);
     }