Enalean / tuleap

plugins/tracker/include/Tracker/FormElement/dao/Tracker_FormElement_Field_OpenListDao.class.php

Doc Comments +4 added lines

@@ -58,6 +58,10 @@
         return $this->update($sql);
     }
     
+    /**
+     * @param integer $changeset_id
+     * @param integer $field_id
+     */
     public function searchChangesetValues($changeset_id, $field_id, $bindtable_select, $bindtable_select_nb, $bindtable_from, $bindtable_join_on_id) {
         $changeset_id = $this->da->escapeInt($changeset_id);
         $field_id     = $this->da->escapeInt($field_id);

plugins/tracker/include/Tracker/FormElement/dao/Tracker_FormElement_Field_Value_ArtifactLinkDao.class.php

Doc Comments +11 added lines

@@ -25,6 +25,9 @@ 
         $this->table_name = 'tracker_changeset_value_artifactlink';
     }
     
+    /**
+     * @param integer $changeset_value_id
+     */
     public function searchById($changeset_value_id) {
         $changeset_value_id = $this->da->escapeInt($changeset_value_id);
 
@@ -51,6 +54,9 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $changeset_value_id
+     */
     public function create($changeset_value_id, array $artifact_ids, $keyword, $group_id) {
         $changeset_value_id = $this->da->escapeInt($changeset_value_id);
         $keyword            = $this->da->quoteSmart($keyword);
@@ -87,6 +93,11 @@ 
         return true;
     }
 
+    /**
+     * @param integer $group_id
+     * @param string $oldKeyword
+     * @param string $keyword
+     */
     public function updateItemName ($group_id, $oldKeyword, $keyword) {
         $group_id = $this->da->quoteSmart($group_id);
         $keyword= $this->da->quoteSmart($keyword);

plugins/tracker/include/Tracker/FormElement/dao/Tracker_FormElement_Field_Value_DateDao.class.php

Doc Comments +4 added lines

@@ -25,6 +25,10 @@
         $this->table_name = 'tracker_changeset_value_date';
     }
     
+    /**
+     * @param integer $changeset_value_id
+     * @param integer $value
+     */
     public function create($changeset_value_id, $value) {
         $changeset_value_id = $this->da->escapeInt($changeset_value_id);
         if ($value === false) {

plugins/tracker/include/Tracker/FormElement/dao/Tracker_FormElement_Field_Value_PermissionsOnArtifactDao.class.php

Doc Comments +3 added lines

@@ -25,6 +25,9 @@
         $this->table_name = 'tracker_changeset_value_permissionsonartifact';
     }
     
+    /**
+     * @param integer $changeset_value_id
+     */
     public function create($changeset_value_id, $use_perm, $value_ids) {
         $changeset_value_id = $this->da->escapeInt($changeset_value_id);
         $use_perm = $this->da->escapeInt($use_perm);

plugins/tracker/include/Tracker/FormElement/dao/Tracker_FormElement_Field_Value_TextDao.class.php

Doc Comments +6 added lines

@@ -25,6 +25,9 @@ 
         $this->table_name = 'tracker_changeset_value_text';
     }
     
+    /**
+     * @param integer $changeset_value_id
+     */
     public function create($changeset_value_id, $value) {
         $changeset_value_id = $this->da->escapeInt($changeset_value_id);
         $value              = $this->da->quoteSmart($value);
@@ -35,6 +38,9 @@ 
         return $this->update($sql);
     }
 
+    /**
+     * @param integer $changeset_value_id
+     */
     public function createWithBodyFormat($changeset_value_id, $value, $body_format) {
         $changeset_value_id = $this->da->escapeInt($changeset_value_id);
         $value              = $this->da->quoteSmart($value);

plugins/tracker/include/Tracker/FormElement/dao/Tracker_FormElement_FieldDao.class.php

Doc Comments +67 added lines

@@ -30,6 +30,10 @@ 
         $this->table_name = 'tracker_field';
     }
     
+    /**
+     * @param integer $tracker_id
+     * @param string $name
+     */
     public function searchByTrackerIdAndName($tracker_id, $name) {
         $tracker_id  = $this->da->escapeInt($tracker_id);
         $name  = $this->da->quoteSmart($name);
@@ -40,6 +44,10 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $tracker_id
+     * @param string $name
+     */
     public function searchUsedByTrackerIdAndName($tracker_id, $name) {
         $tracker_id  = $this->da->escapeInt($tracker_id);
         $name  = $this->da->quoteSmart($name);
@@ -51,6 +59,9 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $tracker_id
+     */
     public function searchUnusedByTrackerId($tracker_id) {
         $tracker_id  = $this->da->escapeInt($tracker_id);
         $sql = "SELECT *
@@ -72,6 +83,9 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $tracker_id
+     */
     public function searchUsedByIdAndType($tracker_id, $field_id, $type) {
         $tracker_id  = $this->da->escapeInt($tracker_id);
         $field_id    = $this->da->escapeInt($field_id);
@@ -91,6 +105,9 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $tracker_id
+     */
     public function searchUsedUserListFieldByTrackerId($tracker_id) {
         $tracker_id  = $this->da->escapeInt($tracker_id);
         $sql = "SELECT *
@@ -115,6 +132,9 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $tracker_id
+     */
     public function searchUsedUserSbFieldByTrackerId($tracker_id) {
         $tracker_id  = $this->da->escapeInt($tracker_id);
         $sql = "SELECT *
@@ -141,6 +161,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $tracker_id
+     */
     public function searchUsedStaticSbFieldByTrackerId($tracker_id) {
         $tracker_id  = $this->da->escapeInt($tracker_id);
         $sql = "SELECT f.*
@@ -172,6 +195,10 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $tracker_id
+     * @param boolean $used
+     */
     function searchUsedByTrackerIdAndType($tracker_id, $type, $used = null) {
         $tracker_id  = $this->da->escapeInt($tracker_id);
         if (is_array($type)) {
@@ -227,6 +254,10 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $tracker_id
+     * @param integer $id
+     */
     function searchNextUsedSibling($tracker_id, $id) {
         $tracker_id = $this->da->escapeInt($tracker_id);
         $id         = $this->da->escapeInt($id);
@@ -240,6 +271,10 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $tracker_id
+     * @param integer $id
+     */
     function searchPreviousUsedSibling($tracker_id, $id) {
         $tracker_id = $this->da->escapeInt($tracker_id);
         $id         = $this->da->escapeInt($id);
@@ -253,6 +288,9 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $tracker_id
+     */
     function searchByTrackerId($tracker_id) {
         $tracker_id  = $this->da->escapeInt($tracker_id);
         $sql = "SELECT *
@@ -262,6 +300,9 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $to_tracker_id
+     */
     public function duplicate($from_field_id, $to_tracker_id) {
         //TODO: duplicate tracker_id
         $from_field_id  = $this->da->escapeInt($from_field_id);
@@ -273,6 +314,9 @@ 
         return $this->updateAndGetLastId($sql);
     }
     
+    /**
+     * @param integer $tracker_id
+     */
     public function mapNewParentsAfterDuplication($tracker_id, $mapping) {
         $tracker_id = $this->da->escapeInt($tracker_id);
         $cases = '';
@@ -331,12 +375,18 @@ 
         return false;
     }
  
+    /**
+     * @param Tracker_FormElement_Field $field
+     */
     public function delete($field) {
         $sql = "DELETE FROM $this->table_name
                 WHERE id = ". $this->da->escapeInt($field->id);
         return $this->update($sql);
     }
     
+    /**
+     * @param integer $id
+     */
     public function searchSharedTargets($id) {
         $id  = $this->da->escapeInt($id);
         $sql = "SELECT * FROM tracker_field WHERE original_field_id = $id";
@@ -378,6 +428,9 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $project_id
+     */
     public function searchProjectSharedFieldsTargets($project_id) {
         $project_id  = $this->da->escapeInt($project_id);
         $sql = "SELECT tracker_field.*
@@ -388,6 +441,9 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $group_id
+     */
     public function searchFieldIdsByGroupId($group_id) {
         $group_id  = $this->da->escapeInt($group_id);
         
@@ -439,6 +495,10 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $tracker_id
+     * @param integer $shared_field_id
+     */
     public function searchFieldFromTrackerIdAndSharedFieldId($tracker_id, $shared_field_id) {
         $tracker_id      = $this->da->escapeInt($tracker_id);
         $shared_field_id = $this->da->escapeInt($shared_field_id);
@@ -462,6 +522,13 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param string $label
+     * @param string $description
+     * @param string $scope
+     * @param boolean $required
+     * @param boolean $notifications
+     */
     public function create($type, $tracker_id, $parent_id, $name, $prefix_name, $label, $description, $use_it, $scope, $required, $notifications, $rank, $original_field_id) {
         $type              = $this->da->quoteSmart($type);
         $tracker_id        = $this->da->escapeInt($tracker_id);

plugins/tracker/include/Tracker/FormElement/dao/Tracker_FormElement_SpecificPropertiesDao.class.php

Doc Comments +6 added lines

@@ -23,6 +23,9 @@ 
  */
 abstract class Tracker_FormElement_SpecificPropertiesDao extends DataAccessObject {
     
+    /**
+     * @param integer $field_id
+     */
     public function searchByFieldId($field_id) {
         $field_id  = $this->da->escapeInt($field_id);
         $sql = "SELECT *
@@ -31,6 +34,9 @@ 
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $field_id
+     */
     public function delete($field_id) {
         $field_id  = $this->da->escapeInt($field_id);
         $sql = "DELETE FROM $this->table_name

plugins/tracker/include/Tracker/FormElement/DateTimeFormatter.class.php

Doc Comments +6 added lines

@@ -26,6 +26,9 @@ 
         parent::__construct($field);
     }
 
+    /**
+     * @param string $value
+     */
     public function validate($value) {
         $is_valid = true;
         if ($value) {
@@ -69,6 +72,9 @@ 
             . ' ' . $date_explode[3].':'.$date_explode[4];
     }
 
+    /**
+     * @param integer $timestamp
+     */
     public function formatDate($timestamp) {
         return format_date(self::DATE_TIME_FORMAT, (float)$timestamp, '');
     }

plugins/tracker/include/Tracker/FormElement/IProvideFactoryButtonInformation.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -31,7 +31,7 @@
     public static function getFactoryDescription();
     
     /**
-     * @return the path to the icon to use an element
+     * @return The|null path to the icon to use an element
      */
     public static function getFactoryIconUseIt();