Merge branch 'develop'

* develop: to update mixed method return value to Model class. (Ex: User|object => User)
lesstif · Jun 3, 2020 · f8feccb · f8feccb
2 parents 203e0b5 + fee79e1
commit f8feccb
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 26 deletions.
diff --git a/src/Auth/AuthService.php b/src/Auth/AuthService.php
@@ -95,7 +95,7 @@ public function __construct(ConfigurationInterface $configuration = null, Logger
      * @throws \JiraRestApi\JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return CurrentUser|object
+     * @return CurrentUser
      */
     public function getCurrentUser()
     {
@@ -140,7 +140,7 @@ public function logout()
      * @throws \JiraRestApi\JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return AuthSession|object
+     * @return AuthSession
      */
     public function login($username = null, $password = null)
     {

diff --git a/src/Field/FieldService.php b/src/Field/FieldService.php
@@ -76,7 +76,7 @@ public function getCustomFieldOption($id)
      * @throws \JiraRestApi\JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return Field|object created field class
+     * @return Field created field class
      */
     public function create(Field $field)
     {

diff --git a/src/Group/GroupService.php b/src/Group/GroupService.php
@@ -18,7 +18,7 @@ class GroupService extends \JiraRestApi\JiraClient
      * @throws \JiraRestApi\JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return Group|object
+     * @return Group
      */
     public function get($paramArray)
     {
@@ -42,7 +42,7 @@ public function get($paramArray)
      * @throws \JiraRestApi\JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return GroupSearchResult|object
+     * @return GroupSearchResult
      */
     public function getMembers($paramArray)
     {
@@ -67,7 +67,7 @@ public function getMembers($paramArray)
      * @throws \JiraRestApi\JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return Group|object
+     * @return Group
      */
     public function createGroup(Group $group)
     {
@@ -94,7 +94,7 @@ public function createGroup(Group $group)
      * @throws \JiraRestApi\JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return Group|object Returns the current state of the group.
+     * @return Group Returns the current state of the group.
      */
     public function addUserToGroup(string $groupName, string $userName)
     {

diff --git a/src/Issue/IssueService.php b/src/Issue/IssueService.php
@@ -14,7 +14,7 @@ class IssueService extends \JiraRestApi\JiraClient
      *
      * @throws \JsonMapper_Exception
      *
-     * @return Issue|object
+     * @return Issue
      */
     public function getIssueFromJSON($json)
     {
@@ -36,7 +36,7 @@ public function getIssueFromJSON($json)
      * @throws JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return Issue|object class
+     * @return Issue class
      */
     public function get($issueIdOrKey, $paramArray = [], $issueObject = null)
     {
@@ -65,7 +65,7 @@ public function get($issueIdOrKey, $paramArray = [], $issueObject = null)
      * @throws JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return Issue|object created issue key
+     * @return Issue created issue key
      */
     public function create($issueField)
     {
@@ -227,7 +227,7 @@ public function update($issueIdOrKey, $issueField, $paramArray = [])
      * @throws JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return Comment|object Comment class
+     * @return Comment Comment class
      */
     public function addComment($issueIdOrKey, $comment)
     {
@@ -260,7 +260,7 @@ public function addComment($issueIdOrKey, $comment)
      * @throws JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return Comment|object Comment class
+     * @return Comment Comment class
      */
     public function updateComment($issueIdOrKey, $id, $comment)
     {
@@ -293,7 +293,7 @@ public function updateComment($issueIdOrKey, $id, $comment)
      * @throws JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return Comment|object Comment class
+     * @return Comment Comment class
      */
     public function getComment($issueIdOrKey, $id, array $paramArray = [])
     {
@@ -319,7 +319,7 @@ public function getComment($issueIdOrKey, $id, array $paramArray = [])
      * @throws JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return Comment|object Comment class
+     * @return Comment Comment class
      */
     public function getComments($issueIdOrKey, array $paramArray = [])
     {
@@ -539,7 +539,7 @@ public function transition($issueIdOrKey, $transition)
      * @throws JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return IssueSearchResult|object
+     * @return IssueSearchResult
      */
     public function search($jql, $startAt = 0, $maxResults = 15, $fields = [], $expand = [], $validateQuery = true)
     {
@@ -632,7 +632,7 @@ public function timeTracking($issueIdOrKey, $timeTracking)
      * @throws JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return PaginatedWorklog|object
+     * @return PaginatedWorklog
      */
     public function getWorklog($issueIdOrKey)
     {
@@ -655,7 +655,7 @@ public function getWorklog($issueIdOrKey)
      * @throws JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return Worklog|object PaginatedWorklog object
+     * @return Worklog PaginatedWorklog object
      */
     public function getWorklogById($issueIdOrKey, $workLogId)
     {
@@ -678,7 +678,7 @@ public function getWorklogById($issueIdOrKey, $workLogId)
      * @throws JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return Worklog|object Worklog Object
+     * @return Worklog Worklog Object
      */
     public function addWorklog($issueIdOrKey, $worklog)
     {
@@ -708,7 +708,7 @@ public function addWorklog($issueIdOrKey, $worklog)
      * @throws JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return Worklog|object
+     * @return Worklog
      */
     public function editWorklog($issueIdOrKey, $worklog, $worklogId)
     {
@@ -779,7 +779,7 @@ public function getAllPriorities()
      * @throws JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return Priority|object priority
+     * @return Priority priority
      */
     public function getPriority($priorityId)
     {
@@ -804,7 +804,7 @@ public function getPriority($priorityId)
      * @throws JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return Priority|object priority
+     * @return Priority priority
      */
     public function getCustomFields($priorityId)
     {

diff --git a/src/Project/ProjectService.php b/src/Project/ProjectService.php
@@ -42,7 +42,7 @@ public function getAllProjects($paramArray = [])
      * @throws \JiraRestApi\JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return Project|object
+     * @return Project
      */
     public function get($projectIdOrKey)
     {
@@ -156,7 +156,7 @@ public function getProjectTypes()
      * @throws \JiraRestApi\JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return ProjectType|object
+     * @return ProjectType
      */
     public function getProjectType($key)
     {
@@ -178,7 +178,7 @@ public function getProjectType($key)
      * @throws \JiraRestApi\JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return ProjectType|object
+     * @return ProjectType
      */
     public function getAccessibleProjectType($key)
     {

diff --git a/src/User/UserService.php b/src/User/UserService.php
@@ -21,7 +21,7 @@ class UserService extends \JiraRestApi\JiraClient
      * @throws \JiraRestApi\JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return User|object User class
+     * @return User User class
      */
     public function create($user)
     {
@@ -46,7 +46,7 @@ public function create($user)
      * @throws \JiraRestApi\JiraException
      * @throws \JsonMapper_Exception
      *
-     * @return User|object User class
+     * @return User User class
      */
     public function get($paramArray)
     {