Enalean / tuleap

plugins/cardwall/include/OnTop/ColumnMappingFieldDao.class.php

Doc Comments +19 added lines

@@ -21,6 +21,9 @@ 
 
 class Cardwall_OnTop_ColumnMappingFieldDao extends DataAccessObject {
 
+    /**
+     * @param integer $cardwall_tracker_id
+     */
     public function searchMappingFields($cardwall_tracker_id) {
         $cardwall_tracker_id = $this->da->escapeInt($cardwall_tracker_id);
         $sql = "SELECT t1.id AS tracker_id, m.field_id AS field_id
@@ -36,6 +39,10 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $cardwall_tracker_id
+     * @param integer $tracker_id
+     */
     public function create($cardwall_tracker_id, $tracker_id, $field_id) {
         $cardwall_tracker_id = $this->da->escapeInt($cardwall_tracker_id);
         $tracker_id          = $this->da->escapeInt($tracker_id);
@@ -49,6 +56,11 @@ 
         return $this->update($sql);
     }
 
+    /**
+     * @param integer $cardwall_tracker_id
+     * @param integer $tracker_id
+     * @param integer $field_id
+     */
     public function save($cardwall_tracker_id, $tracker_id, $field_id) {
         $cardwall_tracker_id = $this->da->escapeInt($cardwall_tracker_id);
         $tracker_id          = $this->da->escapeInt($tracker_id);
@@ -64,6 +76,10 @@ 
         }
     }
 
+    /**
+     * @param integer $cardwall_tracker_id
+     * @param integer $tracker_id
+     */
     public function delete($cardwall_tracker_id, $tracker_id) {
         $cardwall_tracker_id = $this->da->escapeInt($cardwall_tracker_id);
         $tracker_id          = $this->da->escapeInt($tracker_id);
@@ -73,6 +89,9 @@ 
         return $this->update($sql);
     }
 
+    /**
+     * @param integer $cardwall_tracker_id
+     */
     public function deleteCardwall($cardwall_tracker_id) {
         $cardwall_tracker_id = $this->da->escapeInt($cardwall_tracker_id);
         $sql = "DELETE FROM plugin_cardwall_on_top_column_mapping_field

plugins/cardwall/include/OnTop/ColumnMappingFieldValueDao.class.php

Doc Comments +27 added lines

@@ -21,6 +21,9 @@ 
 
 class Cardwall_OnTop_ColumnMappingFieldValueDao extends DataAccessObject {
 
+    /**
+     * @param integer $cardwall_tracker_id
+     */
     public function searchMappingFieldValues($cardwall_tracker_id) {
         $cardwall_tracker_id = $this->da->escapeInt($cardwall_tracker_id);
         $sql = "SELECT *
@@ -29,6 +32,12 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $cardwall_tracker_id
+     * @param integer $tracker_id
+     * @param integer $field_id
+     * @param integer $value_id
+     */
     public function save($cardwall_tracker_id, $tracker_id, $field_id, $value_id, $column_id) {
         $cardwall_tracker_id = $this->da->escapeInt($cardwall_tracker_id);
         $tracker_id          = $this->da->escapeInt($tracker_id);
@@ -44,6 +53,9 @@ 
         }
     }
 
+    /**
+     * @param integer $cardwall_tracker_id
+     */
     public function deleteForColumn($cardwall_tracker_id, $column_id) {
         $cardwall_tracker_id = $this->da->escapeInt($cardwall_tracker_id);
         $column_id           = $this->da->escapeInt($column_id);
@@ -53,6 +65,11 @@ 
         return $this->update($sql);
     }
 
+    /**
+     * @param integer $cardwall_tracker_id
+     * @param integer $tracker_id
+     * @param integer $field_id
+     */
     public function deleteAllFieldValues($cardwall_tracker_id, $tracker_id, $field_id, $column_id) {
         $cardwall_tracker_id = $this->da->escapeInt($cardwall_tracker_id);
         $tracker_id          = $this->da->escapeInt($tracker_id);
@@ -66,6 +83,10 @@ 
         return $this->update($sql);
     }
 
+    /**
+     * @param integer $cardwall_tracker_id
+     * @param integer $tracker_id
+     */
     public function delete($cardwall_tracker_id, $tracker_id) {
         $cardwall_tracker_id = $this->da->escapeInt($cardwall_tracker_id);
         $tracker_id          = $this->da->escapeInt($tracker_id);
@@ -108,6 +129,9 @@ 
         return $this->update($sql);
     }
 
+    /**
+     * @param string $field_name
+     */
     private function associativeToSQLCase(array $mapping, $field_name) {
         $when_then = $this->associativeToSQLWhenThen($mapping);
         return $this->getSQLCase($field_name, $when_then);
@@ -123,6 +147,9 @@ 
         return $stmt;
     }
 
+    /**
+     * @param string $when_then
+     */
     private function getSQLCase($field_name, $when_then) {
         $stmt = " CASE $field_name
                   $when_then

plugins/cardwall/include/OnTop/Config.class.php

Doc Comments -1 removed lines

@@ -84,7 +84,6 @@
     /**
      * Get Frestyle columns for Cardwall_OnTop, or status columns if none
      *
-     * @param Tracker $tracker
      * @return Cardwall_OnTop_Config_ColumnCollection
      */
     public function getDashboardColumns() {

plugins/cardwall/include/OnTop/Config/ColumnFactory.class.php

Doc Comments +4 added lines

@@ -62,6 +62,10 @@
         return $columns;
     }
     
+    /**
+     * @param Cardwall_OnTop_Config_ColumnCollection $columns
+     * @param Tracker_FormElement_Field_List $field
+     */
     private function fillColumnsFor(&$columns, $field) {
         $decorators = $field->getDecorators();
         foreach($field->getVisibleValuesPlusNoneIfAny() as $value) {

plugins/cardwall/include/OnTop/Config/Command/DeleteMappingFields.class.php

Doc Comments +3 added lines

@@ -78,6 +78,9 @@
             && $this->mappingExists($mapping_tracker->getId());
     }
 
+    /**
+     * @param integer $mapping_tracker_id
+     */
     private function mappingExists($mapping_tracker_id) {
         return isset($this->existing_mappings[$mapping_tracker_id])
             && $this->existing_mappings[$mapping_tracker_id] instanceof Cardwall_OnTop_Config_TrackerMappingFreestyle;

plugins/cardwall/include/OnTop/Config/TrackerMappingFactory.class.php

Doc Comments +3 added lines, -2 removed lines

@@ -65,7 +65,7 @@ 
      * Get all mappings defined for the cardwall on top of a tracker
      *
      * @param Tracker $tracker The tracker
-     * @param array   $columns array of Cardwall_Column
+     * @param Cardwall_OnTop_Config_ColumnCollection   $columns array of Cardwall_Column
      *
      * @return Cardwall_OnTop_Config_TrackerMapping[]
      */
@@ -113,6 +113,7 @@ 
     }
 
     /**
+     * @param Tracker_FormElement_Field $mapping_field
      * @return Cardwall_OnTop_Config_TrackerMappingFreestyle
      */
     private function instantiateFreestyleMapping(Tracker $tracker, array &$mappings, Tracker $mapping_tracker, array $available_fields, $mapping_field) {
@@ -126,7 +127,7 @@ 
     }
 
     /**
-     * @return Cardwall_OnTop_Config_TrackerMappingFreestyle
+     * @return Cardwall_OnTop_Config_TrackerMappingNoField
      */
     private function instantiateNoFieldMapping(Tracker $mapping_tracker, array $available_fields) {
         return new Cardwall_OnTop_Config_TrackerMappingNoField(

plugins/cardwall/include/OnTop/Config/ValueMapping.class.php

Doc Comments +6 added lines

@@ -65,10 +65,16 @@
         return $this->matchLabel($artifact_status_label) || $this->matchNone($artifact_status_label);
     }
 
+    /**
+     * @param string $artifact_status_label
+     */
     private function matchLabel($artifact_status_label) {
         return $this->getValueLabel() == $artifact_status_label;
     }
 
+    /**
+     * @param string $artifact_status_label
+     */
     private function matchNone($artifact_status_label) {
         return $artifact_status_label === null && $this->getValueId() == 100;
     }

plugins/cardwall/include/OnTop/Config/View/Admin.class.php

Doc Comments +5 added lines

@@ -29,6 +29,9 @@ 
         return $this->generateAdminForm($config);
     }
 
+    /**
+     * @param Cardwall_OnTop_Config $config
+     */
     private function generateAdminForm($config) {
         $column_definition_view = new Cardwall_OnTop_Config_View_ColumnDefinition($config);
         $checked                = $config->isEnabled() ? 'checked="checked"' : '';
@@ -52,6 +55,8 @@ 
     }
 
      /**
+     * @param string $page
+     * @param string $category
      * @return string
      */
     private function translate($page, $category, $args = "") {

plugins/cardwall/include/OnTop/Config/View/ColumnDefinition.class.php

Doc Comments +9 added lines

@@ -207,6 +207,9 @@ 
         return $html;
     }
 
+    /**
+     * @param Cardwall_Column $column
+     */
     private function decorateEdit($column) {
         $id   = 'column_'. $column->id .'_field';
         $hexa = ColorHelper::CssRGBToHexa($column->bgcolor);
@@ -215,6 +218,10 @@ 
         return $html;
     }
 
+    /**
+     * @param string $id
+     * @param string $classname
+     */
     private function fetchSquareColor($id, $title, $classname, $img = 'blank16x16.png') {
         $html = '';
         $bgcolor = "background-color:$title;";
@@ -261,6 +268,8 @@ 
     }
 
     /**
+     * @param string $page
+     * @param string $category
      * @return string
      */
     protected function translate($page, $category, $args = "") {