update User related class

Author: lesstif

src/Issue/Reporter.php

@@ -10,7 +10,7 @@ class Reporter implements \JsonSerializable
 
     public string $self;
 
-    public ?string $name;
+    public ?string $name = null;
 
     public string $emailAddress;
 
@@ -30,6 +30,11 @@ class Reporter implements \JsonSerializable
 
     public string $locale;
 
+    public string $expand;
+    public array $applicationRoles;
+
+    public array $groups;
+
     #[\ReturnTypeWillChange]
     public function jsonSerialize()
     {

src/User/User.php

@@ -3,98 +3,14 @@
 namespace JiraCloud\User;
 
 use JiraCloud\ClassSerialize;
+use JiraCloud\Issue\Reporter;
 
 /**
  * Description of User.
  *
  * @author Anik
  */
-class User implements \JsonSerializable
+class User extends Reporter
 {
-    use ClassSerialize;
 
-    /**
-     * uri which was hit.
-     *
-     * @var string
-     */
-    public $self;
-
-    /**
-     * @var string
-     */
-    public $key;
-
-    /**
-     * @var string
-     */
-    public $accountId;
-
-    /**
-     * @var string
-     */
-    public $name;
-
-    /**
-     * @var string
-     */
-    public $emailAddress;
-
-    /**
-     * @var object
-     */
-    public $avatarUrls;
-
-    /**
-     * @var string
-     */
-    public $displayName;
-
-    /**
-     * @var bool
-     */
-    public $active;
-
-    /**
-     * @var string
-     */
-    public $timeZone;
-
-    /**
-     * @var array "#/definitions/simple-list-wrapper"
-     */
-    public $groups;
-
-    /**
-     * @var array "#/definitions/simple-list-wrapper"
-     */
-    public $applicationRoles;
-
-    /**
-     * @var string
-     */
-    public $expand;
-
-    /**
-     * @var string Used only for creating a new user
-     */
-    public $password;
-
-    #[\ReturnTypeWillChange]
-    public function jsonSerialize()
-    {
-        return array_filter(get_object_vars($this));
-    }
-
-    /**
-     * User constructor.
-     *
-     * @param array $array user info array.
-     */
-    public function __construct($array = [])
-    {
-        foreach ($array as $key=>$value) {
-            $this->{$key} = $value;
-        }
-    }
 }

src/User/UserService.php

@@ -16,14 +16,14 @@ class UserService extends \JiraCloud\JiraClient
     /**
      * Function to create a new user.
      *
-     * @param User|array $user
-     *
-     * @throws \JiraCloud\JiraException
-     * @throws \JsonMapper_Exception
+     * @param array|User $user
      *
      * @return User User class
+     *@throws \JsonMapper_Exception
+     *
+     * @throws \JiraCloud\JiraException
      */
-    public function create($user)
+    public function create(User|array $user): User
     {
         $data = json_encode($user);
 
@@ -40,15 +40,15 @@ public function create($user)
     /**
      * Function to get user.
      *
-     * @param array $paramArray Possible values for $paramArray 'username', 'key'.
+     * @param array $paramArray Possible values for $paramArray 'accountId', 'key'.
      *                          "Either the 'username' or the 'key' query parameters need to be provided".
      *
-     * @throws \JiraCloud\JiraException
-     * @throws \JsonMapper_Exception
-     *
      * @return User User class
+     *@throws \JsonMapper_Exception
+     *
+     * @throws \JiraCloud\JiraException
      */
-    public function get($paramArray)
+    public function get(array $paramArray): User
     {
         $queryParam = '?'.http_build_query($paramArray);
 
@@ -67,12 +67,12 @@ public function get($paramArray)
      *
      * @param array $paramArray
      *
-     * @throws \JiraCloud\JiraException
-     * @throws \JsonMapper_Exception
-     *
      * @return User[]
+     *@throws \JsonMapper_Exception
+     *
+     * @throws \JiraCloud\JiraException
      */
-    public function findUsers($paramArray)
+    public function findUsers(array $paramArray): array
     {
         $queryParam = '?'.http_build_query($paramArray);
 
@@ -99,14 +99,14 @@ public function findUsers($paramArray)
      *
      * @param array $paramArray
      *
-     * @throws \JiraCloud\JiraException
-     * @throws \JsonMapper_Exception
-     *
      * @return User[]
      *
+     * @throws \JsonMapper_Exception
+     *
+     * @throws \JiraCloud\JiraException
      * @see https://docs.atlassian.com/jira/REST/cloud/#api/2/user-findAssignableUsers
      */
-    public function findAssignableUsers($paramArray)
+    public function findAssignableUsers(array $paramArray): array
     {
         $queryParam = '?'.http_build_query($paramArray);
 
@@ -132,14 +132,14 @@ public function findAssignableUsers($paramArray)
      *
      * @param array $paramArray
      *
-     * @throws \JiraCloud\JiraException
-     * @throws \JsonMapper_Exception
-     *
      * @return User[]
      *
+     * @throws \JsonMapper_Exception
+     *
+     * @throws \JiraCloud\JiraException
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v2/#api-rest-api-2-user-search-query-get
      */
-    public function findUsersByQuery($paramArray)
+    public function findUsersByQuery(array $paramArray): array
     {
         $queryParam = '?'.http_build_query($paramArray);
 
@@ -169,7 +169,7 @@ public function findUsersByQuery($paramArray)
      *
      * @return string
      */
-    public function deleteUser(array $paramArray)
+    public function deleteUser(array $paramArray): string
     {
         $queryParam = '?'.http_build_query($paramArray);
 
@@ -200,12 +200,12 @@ public function getMyself()
     /**
      * @param array $paramArray
      *
-     * @throws \JiraCloud\JiraException
-     * @throws \JsonMapper_Exception
-     *
      * @return User[]
+     *@throws \JsonMapper_Exception
+     *
+     * @throws \JiraCloud\JiraException
      */
-    public function getUsers($paramArray)
+    public function getUsers(array $paramArray): array
     {
         $queryParam = '?'.http_build_query($paramArray);
 
@@ -226,15 +226,15 @@ public function getUsers($paramArray)
     /**
      * Function to update an existing user.
      *
-     * @param array      $paramArray
-     * @param User|array $user
-     *
-     * @throws \JiraCloud\JiraException
-     * @throws \JsonMapper_Exception
+     * @param array $paramArray
+     * @param array|User $user
      *
      * @return User User class
+     *@throws \JsonMapper_Exception
+     *
+     * @throws \JiraCloud\JiraException
      */
-    public function update($paramArray, $user)
+    public function update(array $paramArray, User|array $user): User
     {
         $queryParam = '?'.http_build_query($paramArray);