Merge pull request #274 from Metadrop/fb-users-by-query

Add method that allow find users by query.

Author: lesstif

README.md

@@ -177,6 +177,7 @@ $iss = new IssueService(new ArrayConfiguration(
 - [Get User Info](#get-user-info)
 - [Find Users](#find-users)
 - [Find Assignable Users](#find-assignable-users)
+- [Find Users by query](#find-users-by-query)
 - [Delete User](#delete-user)
 
 ### Group
@@ -1804,6 +1805,35 @@ try {
 
 ```
 
+
+#### Find users by query
+
+[See Jira API reference](https://developer.atlassian.com/cloud/jira/platform/rest/v2/#api-rest-api-2-user-search-query-get)
+
+Returns a list of users that match the search string.
+
+```php
+<?php
+require 'vendor/autoload.php';
+
+use JiraRestApi\JiraException;
+use JiraRestApi\User\UserService;
+
+try {
+    $us = new UserService();
+
+    $paramArray = [
+      'query' => 'is watcher of TEST',
+    ];
+
+    $users = $us->findUsersByQuery($paramArray);
+    var_dump($users);
+} catch (JiraException $e) {
+    print("Error Occured! " . $e->getMessage());
+}
+
+```
+
 #### delete User
 
 [See Jira API reference](https://docs.atlassian.com/software/jira/docs/api/REST/latest/#api/2/user-removeUser)

src/User/UserService.php

@@ -115,6 +115,39 @@ public function findAssignableUsers($paramArray)
         $users = [];
 
         foreach ($userData as $user) {
+            $users[] = $this->json_mapper->map(
+                $user,
+                new User()
+            );
+        }
+
+        return $users;
+    }
+
+    /**
+     * Returns a list of users that match with a specific query.
+     *
+     * @param array $paramArray
+     *
+     * @throws \JiraRestApi\JiraException
+     * @throws \JsonMapper_Exception
+     *
+     * @return User[]
+     *
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v2/#api-rest-api-2-user-search-query-get
+     */
+    public function findUsersByQuery($paramArray)
+    {
+        $queryParam = '?'.http_build_query($paramArray);
+
+        $ret = $this->exec($this->uri.'/search/query'.$queryParam, null);
+
+        $this->log->info("Result=\n".$ret);
+
+        $userData = json_decode($ret);
+        $users = [];
+
+        foreach ($userData->values as $user) {
             $users[] = $this->json_mapper->map(
                 $user, new User()
             );