@@ -44,6 +44,10 @@ |
||
| 44 | 44 | function setModule(&$module) { |
| 45 | 45 | $this->module =& $module; |
| 46 | 46 | } |
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * @param string $commandName |
|
| 50 | + */ |
|
| 47 | 51 | function setSoapCommand($commandName) { |
| 48 | 52 | $this->soapCommand = $commandName; |
| 49 | 53 | } |
@@ -8,6 +8,10 @@ discard block |
||
| 8 | 8 | class CLI_ModuleFactory { |
| 9 | 9 | |
| 10 | 10 | var $root; |
| 11 | + |
|
| 12 | + /** |
|
| 13 | + * @param string $root |
|
| 14 | + */ |
|
| 11 | 15 | function CLI_ModuleFactory($root) { |
| 12 | 16 | $this->root = $root; |
| 13 | 17 | } |
@@ -21,6 +25,9 @@ discard block |
||
| 21 | 25 | return $ok; |
| 22 | 26 | } |
| 23 | 27 | |
| 28 | + /** |
|
| 29 | + * @param string $module |
|
| 30 | + */ |
|
| 24 | 31 | function &getModule($module) { |
| 25 | 32 | $m = null; |
| 26 | 33 | if ($this->exist($module)) { |
@@ -9,6 +9,10 @@ |
||
| 9 | 9 | |
| 10 | 10 | class CLI_Action_Docman_CreateDocument extends CLI_Action_Docman_CreateItem { |
| 11 | 11 | |
| 12 | + /** |
|
| 13 | + * @param string $name |
|
| 14 | + * @param string $description |
|
| 15 | + */ |
|
| 12 | 16 | function CLI_Action_Docman_CreateDocument($name, $description) { |
| 13 | 17 | $this->CLI_Action_Docman_CreateItem($name, $description); |
| 14 | 18 | |
@@ -8,6 +8,11 @@ |
||
| 8 | 8 | require_once(CODENDI_CLI_DIR.'/CLI_Action.class.php'); |
| 9 | 9 | |
| 10 | 10 | class CLI_Action_Tracker_MajFields extends CLI_Action { |
| 11 | + |
|
| 12 | + /** |
|
| 13 | + * @param string $name |
|
| 14 | + * @param string $description |
|
| 15 | + */ |
|
| 11 | 16 | function CLI_Action_Tracker_MajFields($name, $description) { |
| 12 | 17 | $this->CLI_Action($name, $description); |
| 13 | 18 | |
@@ -101,7 +101,6 @@ discard block |
||
| 101 | 101 | * 'tracker', 'group_id', 'project' is a field name. |
| 102 | 102 | * A param which doesn't correspond with a field would be simply ignored. |
| 103 | 103 | * |
| 104 | - * @param array $PARAMS the command line parameters to parse and analyse |
|
| 105 | 104 | * @return array the array of params from the command line. |
| 106 | 105 | */ |
| 107 | 106 | function getArtifactParams($params) { |
@@ -150,7 +149,6 @@ discard block |
||
| 150 | 149 | * 'tracker', 'group_id', 'project' is a field name. |
| 151 | 150 | * A param which doesn't correspond with a field would be simply ignored. |
| 152 | 151 | * |
| 153 | - * @param array $PARAMS the command line parameters to parse and analyse |
|
| 154 | 152 | * @return array the array of params from the command line. |
| 155 | 153 | */ |
| 156 | 154 | function getArtifactCriteria($params) { |
@@ -70,6 +70,9 @@ |
||
| 70 | 70 | return 'plugin_admindelegation'; |
| 71 | 71 | } |
| 72 | 72 | |
| 73 | + /** |
|
| 74 | + * @param integer $limit |
|
| 75 | + */ |
|
| 73 | 76 | function getAllProject($offset, $limit, $condition, $pattern) { |
| 74 | 77 | $projects = array(); |
| 75 | 78 | if (count($condition)> 0){ |
@@ -131,6 +131,9 @@ |
||
| 131 | 131 | ); |
| 132 | 132 | } |
| 133 | 133 | |
| 134 | + /** |
|
| 135 | + * @param string $root_planning_name |
|
| 136 | + */ |
|
| 134 | 137 | private function getPlanningAdminPresenterList(PFUser $user, $group_id, $root_planning_name) { |
| 135 | 138 | $plannings = array(); |
| 136 | 139 | $planning_out_of_hierarchy = array(); |
@@ -35,6 +35,9 @@ discard block |
||
| 35 | 35 | $this->event_manager = EventManager::instance(); |
| 36 | 36 | } |
| 37 | 37 | |
| 38 | + /** |
|
| 39 | + * @param string $type |
|
| 40 | + */ |
|
| 38 | 41 | private function addHit($project_id, $type) { |
| 39 | 42 | $params = array( |
| 40 | 43 | 'project_id' => $project_id, |
@@ -43,22 +46,37 @@ discard block |
||
| 43 | 46 | $this->event_manager->processEvent('aggregate_statistics', $params); |
| 44 | 47 | } |
| 45 | 48 | |
| 49 | + /** |
|
| 50 | + * @param integer $project_id |
|
| 51 | + */ |
|
| 46 | 52 | public function addCardDragAndDropHit($project_id) { |
| 47 | 53 | $this->addHit($project_id, self::CARD_DRAG_AND_DROP); |
| 48 | 54 | } |
| 49 | 55 | |
| 56 | + /** |
|
| 57 | + * @param integer $project_id |
|
| 58 | + */ |
|
| 50 | 59 | public function addExpandCollapseColumnHit($project_id) { |
| 51 | 60 | $this->addHit($project_id, self::EXPAND_COLLAPSE_COLUMN); |
| 52 | 61 | } |
| 53 | 62 | |
| 63 | + /** |
|
| 64 | + * @param integer $project_id |
|
| 65 | + */ |
|
| 54 | 66 | public function addWIPModificationHit($project_id) { |
| 55 | 67 | $this->addHit($project_id, self::WIP_MODIFICATION); |
| 56 | 68 | } |
| 57 | 69 | |
| 70 | + /** |
|
| 71 | + * @param integer $project_id |
|
| 72 | + */ |
|
| 58 | 73 | public function addKanbanRenamingHit($project_id) { |
| 59 | 74 | $this->addHit($project_id, self::KANBAN_RENAMING); |
| 60 | 75 | } |
| 61 | 76 | |
| 77 | + /** |
|
| 78 | + * @param integer $project_id |
|
| 79 | + */ |
|
| 62 | 80 | public function addKanbanAddInPlaceHit($project_id) { |
| 63 | 81 | $this->addHit($project_id, self::KANBAN_ADD_IN_PLACE); |
| 64 | 82 | } |
@@ -73,6 +91,9 @@ discard block |
||
| 73 | 91 | return $res; |
| 74 | 92 | } |
| 75 | 93 | |
| 94 | + /** |
|
| 95 | + * @param string $statistic_name |
|
| 96 | + */ |
|
| 76 | 97 | public function getStatistics($statistic_name, $date_start, $date_end) { |
| 77 | 98 | $statistics_data = array(); |
| 78 | 99 | $params = array( |
@@ -43,6 +43,8 @@ discard block |
||
| 43 | 43 | } |
| 44 | 44 | |
| 45 | 45 | /** |
| 46 | + * @param integer $limit |
|
| 47 | + * @param integer $offset |
|
| 46 | 48 | * @return AgileDashboard_BacklogItem_PaginatedBacklogItemsRepresentations; |
| 47 | 49 | */ |
| 48 | 50 | public function getPaginatedBacklogItemsRepresentationsForMilestone(PFUser $user, Planning_Milestone $milestone, $limit, $offset) { |
@@ -60,6 +62,9 @@ discard block |
||
| 60 | 62 | return $this->getBacklogItemsRepresentations($user, $top_milestone, $strategy); |
| 61 | 63 | } |
| 62 | 64 | |
| 65 | + /** |
|
| 66 | + * @param AgileDashboard_Milestone_Backlog_DescendantBacklogStrategy $strategy |
|
| 67 | + */ |
|
| 63 | 68 | private function getBacklogItemsRepresentations(PFUser $user, Planning_Milestone $milestone, $strategy) { |
| 64 | 69 | $backlog_items = $this->getMilestoneBacklogItems($user, $milestone, $strategy); |
| 65 | 70 | $backlog_items_representations = array(); |
@@ -71,6 +76,9 @@ discard block |
||
| 71 | 76 | return new AgileDashboard_BacklogItem_PaginatedBacklogItemsRepresentations($backlog_items_representations, $backlog_items->getTotalAvaialableSize()); |
| 72 | 77 | } |
| 73 | 78 | |
| 79 | + /** |
|
| 80 | + * @param Planning_Milestone $milestone |
|
| 81 | + */ |
|
| 74 | 82 | private function getMilestoneBacklogItems(PFUser $user, $milestone, $strategy) { |
| 75 | 83 | return $this->backlog_item_collection_factory->getUnplannedOpenCollection($user, $milestone, $strategy, false); |
| 76 | 84 | } |