Add throws phpdoc tag to list() methods

Art4 · Art4 · commit 5dbecd046379 · 2023-12-22T11:28:03.000+01:00
diff --git a/src/Redmine/Api/CustomField.php b/src/Redmine/Api/CustomField.php
@@ -3,6 +3,7 @@
 namespace Redmine\Api;
 
 use Redmine\Exception;
+use Redmine\Exception\SerializerException;
 
 /**
  * Listing custom fields.
@@ -22,6 +23,8 @@ class CustomField extends AbstractApi
      *
      * @param array $params optional parameters to be passed to the api (offset, limit, ...)
      *
+     * @throws SerializerException if response body could not be converted into array
+     *
      * @return array list of custom fields found
      */
     final public function list(array $params = []): array
diff --git a/src/Redmine/Api/Group.php b/src/Redmine/Api/Group.php
@@ -4,6 +4,7 @@
 
 use Redmine\Exception;
 use Redmine\Exception\MissingParameterException;
+use Redmine\Exception\SerializerException;
 use Redmine\Serializer\PathSerializer;
 use Redmine\Serializer\XmlSerializer;
 
@@ -25,6 +26,8 @@ class Group extends AbstractApi
      *
      * @param array $params optional parameters to be passed to the api (offset, limit, ...)
      *
+     * @throws SerializerException if response body could not be converted into array
+     *
      * @return array list of groups found
      */
     final public function list(array $params = []): array
diff --git a/src/Redmine/Api/Issue.php b/src/Redmine/Api/Issue.php
@@ -3,6 +3,7 @@
 namespace Redmine\Api;
 
 use Redmine\Exception;
+use Redmine\Exception\SerializerException;
 use Redmine\Serializer\JsonSerializer;
 use Redmine\Serializer\PathSerializer;
 use Redmine\Serializer\XmlSerializer;
@@ -39,6 +40,8 @@ class Issue extends AbstractApi
      *
      * @param array $params the additional parameters (cf available $params above)
      *
+     * @throws SerializerException if response body could not be converted into array
+     *
      * @return array list of issues found
      */
     final public function list(array $params = []): array
diff --git a/src/Redmine/Api/IssueCategory.php b/src/Redmine/Api/IssueCategory.php
@@ -5,6 +5,7 @@
 use Redmine\Exception;
 use Redmine\Exception\InvalidParameterException;
 use Redmine\Exception\MissingParameterException;
+use Redmine\Exception\SerializerException;
 use Redmine\Serializer\PathSerializer;
 use Redmine\Serializer\XmlSerializer;
 
@@ -28,6 +29,7 @@ class IssueCategory extends AbstractApi
      * @param array      $params            optional parameters to be passed to the api (offset, limit, ...)
      *
      * @throws InvalidParameterException if $projectIdentifier is not of type int or string
+     * @throws SerializerException if response body could not be converted into array
      *
      * @return array list of issue categories found
      */
diff --git a/src/Redmine/Api/IssuePriority.php b/src/Redmine/Api/IssuePriority.php
@@ -3,6 +3,7 @@
 namespace Redmine\Api;
 
 use Redmine\Exception;
+use Redmine\Exception\SerializerException;
 
 /**
  * Listing issue priorities.
@@ -22,6 +23,8 @@ class IssuePriority extends AbstractApi
      *
      * @param array $params optional parameters to be passed to the api (offset, limit, ...)
      *
+     * @throws SerializerException if response body could not be converted into array
+     *
      * @return array list of issue priorities found
      */
     final public function list(array $params = []): array
diff --git a/src/Redmine/Api/IssueRelation.php b/src/Redmine/Api/IssueRelation.php
@@ -3,6 +3,7 @@
 namespace Redmine\Api;
 
 use Redmine\Exception;
+use Redmine\Exception\SerializerException;
 use Redmine\Serializer\JsonSerializer;
 
 /**
@@ -24,6 +25,8 @@ class IssueRelation extends AbstractApi
      * @param int   $issueId the issue id
      * @param array $params  optional parameters to be passed to the api (offset, limit, ...)
      *
+     * @throws SerializerException if response body could not be converted into array
+     *
      * @return array list of relations found
      */
     final public function listByIssueId(int $issueId, array $params = []): array
diff --git a/src/Redmine/Api/IssueStatus.php b/src/Redmine/Api/IssueStatus.php
@@ -3,6 +3,7 @@
 namespace Redmine\Api;
 
 use Redmine\Exception;
+use Redmine\Exception\SerializerException;
 
 /**
  * Listing issue statuses.
@@ -22,6 +23,8 @@ class IssueStatus extends AbstractApi
      *
      * @param array $params optional parameters to be passed to the api (offset, limit, ...)
      *
+     * @throws SerializerException if response body could not be converted into array
+     *
      * @return array list of issue statuses found
      */
     final public function list(array $params = []): array
diff --git a/src/Redmine/Api/Membership.php b/src/Redmine/Api/Membership.php
@@ -5,6 +5,7 @@
 use Redmine\Exception;
 use Redmine\Exception\InvalidParameterException;
 use Redmine\Exception\MissingParameterException;
+use Redmine\Exception\SerializerException;
 use Redmine\Serializer\XmlSerializer;
 
 /**
@@ -27,6 +28,7 @@ class Membership extends AbstractApi
      * @param array      $params            optional parameters to be passed to the api (offset, limit, ...)
      *
      * @throws InvalidParameterException if $projectIdentifier is not of type int or string
+     * @throws SerializerException if response body could not be converted into array
      *
      * @return array list of memberships found
      */
diff --git a/src/Redmine/Api/News.php b/src/Redmine/Api/News.php
@@ -4,6 +4,7 @@
 
 use Redmine\Exception;
 use Redmine\Exception\InvalidParameterException;
+use Redmine\Exception\SerializerException;
 
 /**
  * @see   http://www.redmine.org/projects/redmine/wiki/Rest_News
@@ -22,6 +23,9 @@ class News extends AbstractApi
      * @param string|int $projectIdentifier project id or literal identifier
      * @param array      $params            optional parameters to be passed to the api (offset, limit, ...)
      *
+     * @throws InvalidParameterException if $projectIdentifier is not of type int or string
+     * @throws SerializerException if response body could not be converted into array
+     *
      * @return array list of news found
      */
     final public function listByProject($projectIdentifier, array $params = []): array
@@ -45,6 +49,8 @@ final public function listByProject($projectIdentifier, array $params = []): arr
      *
      * @param array $params optional parameters to be passed to the api (offset, limit, ...)
      *
+     * @throws SerializerException if response body could not be converted into array
+     *
      * @return array list of news found
      */
     final public function list(array $params = []): array
diff --git a/src/Redmine/Api/Project.php b/src/Redmine/Api/Project.php
@@ -4,6 +4,7 @@
 
 use Redmine\Exception;
 use Redmine\Exception\MissingParameterException;
+use Redmine\Exception\SerializerException;
 use Redmine\Serializer\PathSerializer;
 use Redmine\Serializer\XmlSerializer;
 
@@ -25,6 +26,8 @@ class Project extends AbstractApi
      *
      * @param array $params optional parameters to be passed to the api (offset, limit, ...)
      *
+     * @throws SerializerException if response body could not be converted into array
+     *
      * @return array list of projects found
      */
     final public function list(array $params = []): array
diff --git a/src/Redmine/Api/Query.php b/src/Redmine/Api/Query.php
@@ -3,6 +3,7 @@
 namespace Redmine\Api;
 
 use Redmine\Exception;
+use Redmine\Exception\SerializerException;
 
 /**
  * Custom queries retrieval.
@@ -22,6 +23,8 @@ class Query extends AbstractApi
      *
      * @param array $params optional parameters to be passed to the api (offset, limit, ...)
      *
+     * @throws SerializerException if response body could not be converted into array
+     *
      * @return array list of queries found
      */
     final public function list(array $params = []): array
diff --git a/src/Redmine/Api/Role.php b/src/Redmine/Api/Role.php
@@ -3,6 +3,7 @@
 namespace Redmine\Api;
 
 use Redmine\Exception;
+use Redmine\Exception\SerializerException;
 
 /**
  * Listing roles.
@@ -22,6 +23,8 @@ class Role extends AbstractApi
      *
      * @param array $params optional parameters to be passed to the api (offset, limit, ...)
      *
+     * @throws SerializerException if response body could not be converted into array
+     *
      * @return array list of roles found
      */
     final public function list(array $params = []): array
diff --git a/src/Redmine/Api/Search.php b/src/Redmine/Api/Search.php
@@ -3,6 +3,7 @@
 namespace Redmine\Api;
 
 use Redmine\Exception;
+use Redmine\Exception\SerializerException;
 
 /**
  * @see   http://www.redmine.org/projects/redmine/wiki/Rest_Search
@@ -19,6 +20,8 @@ class Search extends AbstractApi
      * @param string $query  string to search
      * @param array  $params optional parameters to be passed to the api (offset, limit, ...)
      *
+     * @throws SerializerException if response body could not be converted into array
+     *
      * @return array list of results (projects, issues)
      */
     final public function listByQuery(string $query, array $params = []): array
diff --git a/src/Redmine/Api/TimeEntry.php b/src/Redmine/Api/TimeEntry.php
@@ -4,6 +4,7 @@
 
 use Redmine\Exception;
 use Redmine\Exception\MissingParameterException;
+use Redmine\Exception\SerializerException;
 use Redmine\Serializer\XmlSerializer;
 
 /**
@@ -24,6 +25,8 @@ class TimeEntry extends AbstractApi
      *
      * @param array $params optional parameters to be passed to the api (offset, limit, ...)
      *
+     * @throws SerializerException if response body could not be converted into array
+     *
      * @return array list of time entries found
      */
     final public function list(array $params = []): array
diff --git a/src/Redmine/Api/TimeEntryActivity.php b/src/Redmine/Api/TimeEntryActivity.php
@@ -3,6 +3,7 @@
 namespace Redmine\Api;
 
 use Redmine\Exception;
+use Redmine\Exception\SerializerException;
 
 /**
  * Listing time entry activities.
@@ -20,6 +21,8 @@ class TimeEntryActivity extends AbstractApi
      *
      * @param array $params optional parameters to be passed to the api (offset, limit, ...)
      *
+     * @throws SerializerException if response body could not be converted into array
+     *
      * @return array list of time entry activities found
      */
     final public function list(array $params = []): array
diff --git a/src/Redmine/Api/Tracker.php b/src/Redmine/Api/Tracker.php
@@ -3,6 +3,7 @@
 namespace Redmine\Api;
 
 use Redmine\Exception;
+use Redmine\Exception\SerializerException;
 
 /**
  * Listing trackers.
@@ -22,6 +23,8 @@ class Tracker extends AbstractApi
      *
      * @param array $params optional parameters to be passed to the api (offset, limit, ...)
      *
+     * @throws SerializerException if response body could not be converted into array
+     *
      * @return array list of trackers found
      */
     final public function list(array $params = []): array
diff --git a/src/Redmine/Api/User.php b/src/Redmine/Api/User.php
@@ -4,6 +4,7 @@
 
 use Redmine\Exception;
 use Redmine\Exception\MissingParameterException;
+use Redmine\Exception\SerializerException;
 use Redmine\Serializer\PathSerializer;
 use Redmine\Serializer\XmlSerializer;
 
@@ -25,6 +26,8 @@ class User extends AbstractApi
      *
      * @param array $params to allow offset/limit (and more) to be passed
      *
+     * @throws SerializerException if response body could not be converted into array
+     *
      * @return array list of users found
      */
     final public function list(array $params = []): array
diff --git a/src/Redmine/Api/Version.php b/src/Redmine/Api/Version.php
@@ -5,6 +5,7 @@
 use Redmine\Exception;
 use Redmine\Exception\InvalidParameterException;
 use Redmine\Exception\MissingParameterException;
+use Redmine\Exception\SerializerException;
 use Redmine\Serializer\XmlSerializer;
 
 /**
@@ -26,6 +27,8 @@ class Version extends AbstractApi
      * @param string|int $projectIdentifier project id or literal identifier
      * @param array      $params            optional parameters to be passed to the api (offset, limit, ...)
      *
+     * @throws SerializerException if response body could not be converted into array
+     *
      * @return array list of versions found
      */
     final public function listByProject($projectIdentifier, array $params = []): array
diff --git a/src/Redmine/Api/Wiki.php b/src/Redmine/Api/Wiki.php
@@ -4,6 +4,7 @@
 
 use Redmine\Exception;
 use Redmine\Exception\InvalidParameterException;
+use Redmine\Exception\SerializerException;
 use Redmine\Serializer\PathSerializer;
 use Redmine\Serializer\XmlSerializer;
 
@@ -26,6 +27,8 @@ class Wiki extends AbstractApi
      * @param int|string $projectIdentifier project id or slug
      * @param array      $params  optional parameters to be passed to the api (offset, limit, ...)
      *
+     * @throws SerializerException if response body could not be converted into array
+     *
      * @return array list of wiki pages found for the given project
      */
     final public function listByProject($projectIdentifier, array $params = []): array

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`namespace Redmine\Api;`
`4`	`4`
`5`	`5`	`use Redmine\Exception;`
	`6`	`+use Redmine\Exception\SerializerException;`
`6`	`7`
`7`	`8`	`/**`
`8`	`9`	`* Listing custom fields.`
`@@ -22,6 +23,8 @@ class CustomField extends AbstractApi`
`22`	`23`	`*`
`23`	`24`	`* @param array $params optional parameters to be passed to the api (offset, limit, ...)`
`24`	`25`	`*`
	`26`	`+ * @throws SerializerException if response body could not be converted into array`
	`27`	`+ *`
`25`	`28`	`* @return array list of custom fields found`
`26`	`29`	`*/`
`27`	`30`	`final public function list(array $params = []): array`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`
`5`	`5`	`use Redmine\Exception;`
`6`	`6`	`use Redmine\Exception\MissingParameterException;`
	`7`	`+use Redmine\Exception\SerializerException;`
`7`	`8`	`use Redmine\Serializer\PathSerializer;`
`8`	`9`	`use Redmine\Serializer\XmlSerializer;`
`9`	`10`
`@@ -25,6 +26,8 @@ class Group extends AbstractApi`
`25`	`26`	`*`
`26`	`27`	`* @param array $params optional parameters to be passed to the api (offset, limit, ...)`
`27`	`28`	`*`
	`29`	`+ * @throws SerializerException if response body could not be converted into array`
	`30`	`+ *`
`28`	`31`	`* @return array list of groups found`
`29`	`32`	`*/`
`30`	`33`	`final public function list(array $params = []): array`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`use Redmine\Exception;`
`6`	`6`	`use Redmine\Exception\InvalidParameterException;`
`7`	`7`	`use Redmine\Exception\MissingParameterException;`
	`8`	`+use Redmine\Exception\SerializerException;`
`8`	`9`	`use Redmine\Serializer\PathSerializer;`
`9`	`10`	`use Redmine\Serializer\XmlSerializer;`
`10`	`11`
`@@ -28,6 +29,7 @@ class IssueCategory extends AbstractApi`
`28`	`29`	`* @param array $params optional parameters to be passed to the api (offset, limit, ...)`
`29`	`30`	`*`
`30`	`31`	`* @throws InvalidParameterException if $projectIdentifier is not of type int or string`
	`32`	`+ * @throws SerializerException if response body could not be converted into array`
`31`	`33`	`*`
`32`	`34`	`* @return array list of issue categories found`
`33`	`35`	`*/`