UserService::update() - Code Metrics - Inspection of "Feature/update user (#369)" - lesstif/php-jira-rest-client - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 67574e...62715e )

by KwangSeob
created 2020-12-17 11:47 UTC
UserService::update() A

↳ Parent: UserService
Complexity

Conditions	1
Paths	1
Size

Total Lines	13
Code Lines	7
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	7
c	1
b	0
f	0
nc	1
nop	2
dl	0
loc	13
rs	10
<?php

namespace JiraRestApi\User;

use JiraRestApi\Issue\Reporter;

/**
 * Class to perform all user related queries.
 *
 * @author Anik
 */
class UserService extends \JiraRestApi\JiraClient
{
    private $uri = '/user';

    /**
     * Function to create a new user.
     *
     * @param User|array $user
     *
     * @throws \JiraRestApi\JiraException
     * @throws \JsonMapper_Exception
     *
     * @return User User class
     */
    public function create($user)
    {
        $data = json_encode($user);

        $this->log->info("Create User=\n".$data);

        $ret = $this->exec($this->uri, $data, 'POST');

        return $this->json_mapper->map(
            json_decode($ret),
            json_decode(/** @scrutinizer ignore-type */ $ret),
            new User()
        );
    }

    /**
     * Function to get user.
     *
     * @param array $paramArray Possible values for $paramArray 'username', 'key'.
     *                          "Either the 'username' or the 'key' query parameters need to be provided".
     *
     * @throws \JiraRestApi\JiraException
     * @throws \JsonMapper_Exception
     *
     * @return User User class
     */
    public function get($paramArray)
    {
        $queryParam = '?'.http_build_query($paramArray);

        $ret = $this->exec($this->uri.$queryParam, null);

        $this->log->info("Result=\n".$ret);
        $this->log->info("Result=\n"./** @scrutinizer ignore-type */ $ret);

        return $this->json_mapper->map(
            json_decode($ret),
            json_decode(/** @scrutinizer ignore-type */ $ret),
            new User()
        );
    }

    /**
     * Returns a list of users that match the search string and/or property.
     *
     * @param array $paramArray
     *
     * @throws \JiraRestApi\JiraException
     * @throws \JsonMapper_Exception
     *
     * @return User[]
     */
    public function findUsers($paramArray)
    {
        $queryParam = '?'.http_build_query($paramArray);

        $ret = $this->exec($this->uri.'/search'.$queryParam, null);

        $this->log->info("Result=\n".$ret);
        $this->log->info("Result=\n"./** @scrutinizer ignore-type */ $ret);

        $userData = json_decode($ret);
        $userData = json_decode(/** @scrutinizer ignore-type */ $ret);
        $users = [];

        foreach ($userData as $user) {
            $users[] = $this->json_mapper->map(
                $user,
                new User()
            );
        }

        return $users;
    }

    /**
     * Returns a list of users that match the search string.
     * Please note that this resource should be called with an issue key when a list of assignable users is retrieved for editing.
     *
     * @param array $paramArray
     *
     * @throws \JiraRestApi\JiraException
     * @throws \JsonMapper_Exception
     *
     * @return User[]
     *
     * @see https://docs.atlassian.com/jira/REST/cloud/#api/2/user-findAssignableUsers
     */
    public function findAssignableUsers($paramArray)
    {
        $queryParam = '?'.http_build_query($paramArray);

        $ret = $this->exec($this->uri.'/assignable/search'.$queryParam, null);

        $this->log->info("Result=\n".$ret);
        $this->log->info("Result=\n"./** @scrutinizer ignore-type */ $ret);

        $userData = json_decode($ret);
        $userData = json_decode(/** @scrutinizer ignore-type */ $ret);
        $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);
        $this->log->info("Result=\n"./** @scrutinizer ignore-type */ $ret);

        $userData = json_decode($ret);
        $userData = json_decode(/** @scrutinizer ignore-type */ $ret);
        $users = [];

        foreach ($userData->values as $user) {
            $users[] = $this->json_mapper->map(
                $user,
                new User()
            );
        }

        return $users;
    }

    /**
     * Delete a User.
     *
     * @param array $paramArray username or keys
     *
     * @throws \JiraRestApi\JiraException
     *
     * @return string
     */
    public function deleteUser(array $paramArray)
    {
        $queryParam = '?'.http_build_query($paramArray);

        $ret = $this->exec($this->uri.$queryParam, null, 'DELETE');

        return $ret;

    }

    /**
     * get a user info details.
     *
     * @throws \JiraRestApi\JiraException
     *
     * @return Reporter user Object
     */
    public function getMyself()
    {
        $ret = $this->exec('myself', null);

        $user = $this->json_mapper->map(
            json_decode($ret),
            json_decode(/** @scrutinizer ignore-type */ $ret),
            new Reporter()
        );

        return $user;
    }

    /**
     * @param array $paramArray
     *
     * @throws \JiraRestApi\JiraException
     * @throws \JsonMapper_Exception
     *
     * @return User[]
     */
    public function getUsers($paramArray)
    {
        $queryParam = '?'.http_build_query($paramArray);

        $ret = $this->exec('/users'.$queryParam, null);

        $this->log->info("Result=\n".$ret);
        $this->log->info("Result=\n"./** @scrutinizer ignore-type */ $ret);

        $userData = json_decode($ret);
        $userData = json_decode(/** @scrutinizer ignore-type */ $ret);
        $users = [];

        foreach ($userData as $user) {
            $users[] = $this->json_mapper->map($user, new User());
        }

        return $users;
    }

    /**
     * Function to update an existing user.
     *
     * @param array $paramArray
     * @param User|array $user
     *
     * @throws \JiraRestApi\JiraException
     * @throws \JsonMapper_Exception
     *
     * @return User User class
     */
    public function update($paramArray, $user)
    {
        $queryParam = '?'.http_build_query($paramArray);

        $data = json_encode($user);

        $this->log->info("Update User (".$queryParam.") =\n".$data);

        $ret = $this->exec($this->uri.$queryParam, $data, 'PUT');

        return $this->json_mapper->map(
            json_decode($ret),
            json_decode(/** @scrutinizer ignore-type */ $ret),
            new User()
        );
    }
}

lesstif / php-jira-rest-client

Push — master ( 67574e...62715e )

UserService::update() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
