Enalean / tuleap

plugins/tracker/include/REST/FieldListStaticValueRepresentation.class.php

Unused Use Statements -1 removed lines

@@ -22,7 +22,6 @@
 
 use \Tracker_FormElement_Field_List_Value;
 use Tuleap\REST\JsonCast;
-use Project;
 
 class FieldListStaticValueRepresentation {
     /**

plugins/tracker/include/REST/TrackerRestBuilder.class.php

Doc Comments +1 added lines

@@ -80,6 +80,7 @@
 
     /**
      * @param PFUser $user
+     * @param integer $project_id
      * @return Tuleap\Tracker\REST\WorkflowRepresentation | null
      */
     private function getWorkflowRepresentation(Workflow $workflow, PFUser $user, $project_id) {

plugins/tracker/include/REST/v1/ArtifactFilesResource.class.php

Doc Comments +9 added lines

@@ -102,6 +102,9 @@ 
     /**
      * @throws 403
      * @throws 404
+     * @param integer $id
+     * @param integer $offset
+     * @param integer $limit
      */
     private function getAttachedFileContent($id, $offset, $limit) {
         try {
@@ -116,6 +119,7 @@ 
 
     /**
      * @throws 406
+     * @param integer $limit
      */
     private function checkLimitValue($limit) {
         if ($limit > self::DEFAULT_LIMIT) {
@@ -128,12 +132,17 @@ 
         Header::sendMaxFileChunkSizeHeaders(self::DEFAULT_LIMIT);
     }
 
+    /**
+     * @param integer $limit
+     * @param integer $offset
+     */
     private function sendPaginationHeaders($limit, $offset, $size) {
         Header::sendPaginationHeaders($limit, $offset, $size, FileManager::getMaximumChunkSize());
     }
 
     /**
      * @throws 404
+     * @param integer $id
      */
     private function getAttachedFileSize($id) {
         try {

plugins/tracker/include/REST/v1/ArtifactsResource.class.php

Doc Comments +4 added lines, -1 removed lines

@@ -136,7 +136,7 @@ 
      * @param int    $id            Id of the artifact
      * @param string $values_format The format of the value {@from query} {@choice ,collection,by_field,all}
      *
-     * @return Tuleap\Tracker\REST\Artifact\ArtifactRepresentation
+     * @return ArtifactRepresentation
      */
     public function getId($id, $values_format = self::VALUES_DEFAULT) {
         $this->checkAccess();
@@ -421,6 +421,9 @@ 
         Header::eTag($artifact->getVersionIdentifier());
     }
 
+    /**
+     * @param string $uri
+     */
     private function sendLocationHeader($uri) {
         $uri_with_api_version = '/api/v1/' . $uri;
 

plugins/tracker/include/REST/v1/ArtifactTemporaryFilesResource.class.php

Doc Comments +13 added lines, -1 removed lines

@@ -136,6 +136,9 @@ 
     /**
      * @throws 401
      * @throws 404
+     * @param integer $id
+     * @param integer $offset
+     * @param integer $limit
      */
     private function getTemporaryFileContent($id, $offset, $limit) {
         $file = $this->getFile($id);
@@ -150,6 +153,7 @@ 
 
     /**
      * @throws 404
+     * @param integer $id
      */
     private function getTemporaryFileSize($id) {
         return $this->getFile($id)->getSize();
@@ -352,6 +356,10 @@ 
         Header::sendMaxFileChunkSizeHeaders(FileManager::getMaximumChunkSize());
     }
 
+    /**
+     * @param integer $limit
+     * @param integer $offset
+     */
     private function sendPaginationHeaders($limit, $offset, $size) {
         Header::sendPaginationHeaders($limit, $offset, $size, FileManager::getMaximumChunkSize());
     }
@@ -359,7 +367,7 @@ 
     /**
      * @param int $fileinfo_id
      *
-     * @return Tracker_Artifact
+     * @return \Tracker_Artifact|null
      */
     private function getArtifactByFileInfoId($fileinfo_id) {
         try {
@@ -376,6 +384,9 @@ 
         }
     }
 
+    /**
+     * @param string $id
+     */
     private function removeTemporaryFile($id) {
         $file = $this->getFile($id);
         $this->file_manager->removeTemporaryFile($file);
@@ -389,6 +400,7 @@ 
 
     /**
      * @throws 406
+     * @param integer $limit
      */
     private function checkLimitValue($limit) {
         if ($limit > self::DEFAULT_LIMIT) {

plugins/tracker/include/REST/v1/ProjectTrackersResource.class.php

Doc Comments +3 added lines

@@ -65,6 +65,9 @@
         $this->sendAllowHeaders();
     }
 
+    /**
+     * @param integer $size
+     */
     private function sendPaginationHeaders($limit, $offset, $size) {
         header('X-PAGINATION-LIMIT: '. $limit);
         header('X-PAGINATION-OFFSET: '. $offset);

plugins/tracker/include/REST/v1/ReportsResource.class.php

Doc Comments +7 added lines, -2 removed lines

@@ -77,7 +77,7 @@ 
      *
      * @param int $id Id of the report
      *
-     * @return Tuleap\Tracker\REST\ReportRepresentation
+     * @return ReportRepresentation
      */
     public function getId($id) {
         $this->checkAccess();
@@ -167,6 +167,7 @@ 
     }
 
     /**
+     * @param boolean $with_all_field_values
      * @return Tuleap\Tracker\REST\Artifact\ArtifactRepresentation[]
      */
     private function getListOfArtifactRepresentation(PFUser $user, $artifacts, $with_all_field_values) {
@@ -195,7 +196,8 @@ 
         return array_values(array_filter($list_of_artifact_representation));
     }
 
-    /** @return Tracker_Report */
+    /** @param integer $id
+/** @return \Tracker_Report */
     private function getReportById(\PFUser $user, $id) {
         $store_in_session = false;
         $report = Tracker_ReportFactory::instance()->getReportById(
@@ -218,6 +220,9 @@ 
         return $report;
     }
 
+    /**
+     * @param integer $limit
+     */
     private function checkLimitValue($limit) {
         if ($limit > self::MAX_LIMIT) {
             throw new LimitOutOfBoundsException(self::MAX_LIMIT);

plugins/tracker/include/REST/v1/TrackersResource.class.php

Doc Comments +10 added lines, -2 removed lines

@@ -113,7 +113,7 @@ 
      *
      * @param int $id Id of the tracker
      *
-     * @return Tuleap\Tracker\REST\TrackerRepresentation
+     * @return \Tuleap\Tracker\REST\TrackerRepresentation
      */
     public function getId($id) {
         $this->checkAccess();
@@ -211,7 +211,7 @@ 
      * @param string $order By default the artifacts are returned by Artifact ID ASC. Set this parameter to either ASC or DESC
      *                      <b>Does not work with the query parameter</b> {@from path}{@choice asc,desc}
      *
-     * @return array {@type Tuleap\Tracker\REST\Artifact\ArtifactRepresentation}
+     * @return Tuleap\Tracker\REST\Artifact\ArtifactRepresentation[] {@type Tuleap\Tracker\REST\Artifact\ArtifactRepresentation}
      * @throws RestException 400
      */
     public function getArtifacts(
@@ -256,6 +256,9 @@ 
 
     /**
      * @throws RestException 400
+     * @param string $query
+     * @param integer $offset
+     * @param integer $limit
      */
     private function getArtifactsMatchingQuery(PFUser $user, Tracker $tracker, $query, $offset, $limit) {
         $report = new Tracker_Report_REST(
@@ -287,6 +290,7 @@ 
     }
 
     /**
+     * @param boolean $with_all_field_values
      * @return Tuleap\Tracker\REST\Artifact\ArtifactRepresentation[]
      */
     private function getListOfArtifactRepresentation(PFUser $user, $artifacts, $with_all_field_values) {
@@ -363,6 +367,7 @@ 
     }
 
     /**
+     * @param integer $id
      * @return Tracker
      * @throws RestException
      */
@@ -404,6 +409,9 @@ 
         Header::allowOptionsGet();
     }
 
+    /**
+     * @param integer $limit
+     */
     private function checkLimitValue($limit) {
         if ($limit > self::MAX_LIMIT) {
             throw new LimitOutOfBoundsException(self::MAX_LIMIT);

plugins/tracker/include/REST/WorkflowRepresentation.class.php

Doc Comments +4 added lines

@@ -44,6 +44,10 @@
      */
     public $transitions = array();
 
+    /**
+     * @param integer $id
+     * @param boolean $is_used
+     */
     public function build($id, $is_used, WorkflowRulesRepresentation $rules, array $transitions) {
         $this->field_id    = JsonCast::toInt($id);
         $this->is_used     = $is_used;