IssueService::update() - Code Metrics - Inspection of "added deleteWorkflow method to JiraRestApi\Issue\I..." - lesstif/php-jira-rest-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#303)

by Andrejs
created 2020-03-18 13:26 UTC
IssueService::update() A

↳ Parent: IssueService
Complexity

Conditions	1
Paths	1
Size

Total Lines	18
Code Lines	7
Duplication

Lines	0
Ratio	0 %
Importance

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

namespace JiraRestApi\Issue;

use JiraRestApi\JiraException;

class IssueService extends \JiraRestApi\JiraClient
{
    private $uri = '/issue';

    /**
     * @param $json
     *
     * @throws \JsonMapper_Exception
     *
     * @return Issue|object
     */
    public function getIssueFromJSON($json)
    {
        $issue = $this->json_mapper->map(
            $json, new Issue()
        );

        return $issue;
    }

    /**
     *  get all project list.
     *
     * @param string|int $issueIdOrKey
     * @param array      $paramArray   Query Parameter key-value Array.
     * @param Issue      $issueObject
     *
     * @throws JiraException
     * @throws \JsonMapper_Exception
     *
     * @return Issue|object class
     */
    public function get($issueIdOrKey, $paramArray = [], $issueObject = null)
    {
        // for REST API V3
        if ($this->isRestApiV3()) {
            $issueObject = ($issueObject) ? $issueObject : new IssueV3();
        } else {
            $issueObject = ($issueObject) ? $issueObject : new Issue();
        }

        $ret = $this->exec($this->uri.'/'.$issueIdOrKey.$this->toHttpQueryParameter($paramArray), null);

        $this->log->info("Result=\n".$ret);

        return $issue = $this->json_mapper->map(

            json_decode($ret), $issueObject
        );
    }

    /**
     * create new issue.
     *
     * @param IssueField $issueField
     *
     * @throws JiraException
     * @throws \JsonMapper_Exception
     *
     * @return Issue|object created issue key
     */
    public function create($issueField)
    {
        $issue = new Issue();

        // serilize only not null field.
        $issue->fields = $issueField;

        $data = json_encode($issue);

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

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

        return $this->getIssueFromJSON(json_decode($ret));
    }

    /**
     * Create multiple issues using bulk insert.
     *
     * @param IssueField[] $issueFields Array of IssueField objects
     * @param int          $batchSize   Maximum number of issues to send in each request
     *
     * @throws JiraException
     * @throws \JsonMapper_Exception
     *
     * @return array Array of results, where each result represents one batch of insertions
     */
    public function createMultiple($issueFields, $batchSize = 50)
    {
        $issues = [];

        foreach ($issueFields as $issueField) {
            $issue = new Issue();
            $issue->fields = $issueField;
            $issues[] = $issue;
        }

        $batches = array_chunk($issues, $batchSize);

        $results = [];
        foreach ($batches as $batch) {
            $results = array_merge($results, $this->bulkInsert($batch));
        }

        return $results;
    }

    /**
     * Makes API call to bulk insert issues.
     *
     * @param Issue[] $issues Array of issue arrays that are sent to Jira one by one in single create
     *
     * @throws JiraException
     * @throws \JsonMapper_Exception
     *
     * @return Issue[] Result of API call to insert many issues
     */
    private function bulkInsert($issues)
    {
        $data = json_encode(['issueUpdates' => $issues]);

        $this->log->info("Create Issues=\n".$data);
        $results = $this->exec($this->uri.'/bulk', $data, 'POST');

        $issues = [];
        foreach (json_decode($results)->issues as $result) {
            $issues[] = $this->getIssueFromJSON($result);
        }

        return $issues;
    }

    /**
     * Add one or more file to an issue.
     *
     * @param string|int   $issueIdOrKey  Issue id or key
     * @param array|string $filePathArray attachment file path.
     *
     * @throws JiraException
     * @throws \JsonMapper_Exception
     *
     * @return Attachment[]
     */
    public function addAttachments($issueIdOrKey, $filePathArray)
    {
        if (is_array($filePathArray) == false) {

            $filePathArray = [$filePathArray];
        }

        $results = $this->upload($this->uri."/$issueIdOrKey/attachments", $filePathArray);
        $results = $this->upload($this->uri."/$issueIdOrKey/attachments", /** @scrutinizer ignore-type */ $filePathArray);

        $this->log->info('addAttachments result='.var_export($results, true));

        $attachArr = [];
        foreach ($results as $ret) {
            $ret = json_decode($ret);
            if (is_array($ret)) {
                $tmpArr = $this->json_mapper->mapArray(
                    $ret, new \ArrayObject(), '\JiraRestApi\Issue\Attachment'
                );

                foreach ($tmpArr as $t) {
                    array_push($attachArr, $t);
                }
            } elseif (is_object($ret)) {
                array_push($attachArr, $this->json_mapper->map(
                    $ret, new Attachment()
                    )
                );
            }
        }

        return $attachArr;
    }

    /**
     * update issue.
     *
     * @param string|int $issueIdOrKey Issue Key
     * @param IssueField $issueField   object of Issue class
     * @param array      $paramArray   Query Parameter key-value Array.
     *
     * @throws JiraException
     *
     * @return string created issue key
     */
    public function update($issueIdOrKey, $issueField, $paramArray = [])
    {
        $issue = new Issue();

        // serilize only not null field.
        $issue->fields = $issueField;

        //$issue = $this->filterNullVariable((array)$issue);

        $data = json_encode($issue);

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

        $queryParam = '?'.http_build_query($paramArray);

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

        return $ret;
    }

    /**
     * Adds a new comment to an issue.
     *
     * @param string|int $issueIdOrKey Issue id or key
     * @param Comment    $comment
     *
     * @throws JiraException
     * @throws \JsonMapper_Exception
     *
     * @return Comment|object Comment class
     */
    public function addComment($issueIdOrKey, $comment)
    {
        $this->log->info("addComment=\n");

        if (!($comment instanceof Comment) || empty($comment->body)) {

            throw new JiraException('comment param must instance of Comment and have to body text.!');
        }

        $data = json_encode($comment);

        $ret = $this->exec($this->uri."/$issueIdOrKey/comment", $data);

        $this->log->debug('add comment result='.var_export($ret, true));
        $comment = $this->json_mapper->map(
           json_decode($ret), new Comment()
        );

        return $comment;
    }

    /**
     * Update a comment in issue.
     *
     * @param string|int $issueIdOrKey Issue id or key
     * @param string|int $id           Comment id
     * @param Comment    $comment
     *
     * @throws JiraException
     * @throws \JsonMapper_Exception
     *
     * @return Comment|object Comment class
     */
    public function updateComment($issueIdOrKey, $id, $comment)
    {
        $this->log->info("updateComment=\n");

        if (!($comment instanceof Comment) || empty($comment->body)) {

            throw new JiraException('comment param must instance of Comment and have to body text.!');
        }

        $data = json_encode($comment);

        $ret = $this->exec($this->uri."/$issueIdOrKey/comment/$id", $data, 'PUT');

        $this->log->debug('update comment result='.var_export($ret, true));
        $comment = $this->json_mapper->map(
            json_decode($ret), new Comment()
        );

        return $comment;
    }

    /**
     * Get a comment on an issue.
     *
     * @param string|int $issueIdOrKey Issue id or key
     * @param string|int $id           Comment id
     *
     * @throws JiraException
     * @throws \JsonMapper_Exception
     *
     * @return Comment|object Comment class
     */
    public function getComment($issueIdOrKey, $id)
    {
        $this->log->info("getComment=\n");

        $ret = $this->exec($this->uri."/$issueIdOrKey/comment/$id");

        $this->log->debug('get comment result='.var_export($ret, true));
        $comment = $this->json_mapper->map(
                json_decode($ret), new Comment()
                );

        return $comment;
    }

    /**
     * Get all comments on an issue.
     *
     * @param string|int $issueIdOrKey Issue id or key
     *
     * @throws JiraException
     * @throws \JsonMapper_Exception
     *
     * @return Comment|object Comment class
     */
    public function getComments($issueIdOrKey)
    {
        $this->log->info("getComments=\n");

        $ret = $this->exec($this->uri."/$issueIdOrKey/comment");

        $this->log->debug('get comments result='.var_export($ret, true));
        $comment = $this->json_mapper->map(
                json_decode($ret), new Comment()
                );

        return $comment;
    }

    /**
     * Delete a comment on an issue.
     *
     * @param string|int $issueIdOrKey Issue id or key
     * @param string|int $id           Comment id
     *
     * @throws JiraException
     *
     * @return string|bool
     */
    public function deleteComment($issueIdOrKey, $id)
    {
        $this->log->info("deleteComment=\n");

        $ret = $this->exec($this->uri."/$issueIdOrKey/comment/$id", '', 'DELETE');

        $this->log->info('delete comment '.$issueIdOrKey.' '.$id.' result='.var_export($ret, true));

        return $ret;
    }

    /**
     * Change a issue assignee.
     *
     * @param string|int  $issueIdOrKey
     * @param string|null $assigneeName Assigns an issue to a user.
     *                                  If the assigneeName is "-1" automatic assignee is used.
     *                                  A null name will remove the assignee.
     *
     * @throws JiraException
     *
     * @return string|bool
     */
    public function changeAssignee($issueIdOrKey, $assigneeName)
    {
        $this->log->info("changeAssignee=\n");

        $ar = ['name' => $assigneeName];

        $data = json_encode($ar);

        $ret = $this->exec($this->uri."/$issueIdOrKey/assignee", $data, 'PUT');

        $this->log->info('change assignee of '.$issueIdOrKey.' to '.$assigneeName.' result='.var_export($ret, true));

        return $ret;
    }

    /**
     * Change a issue assignee for REST API V3.
     *
     * @param string|int  $issueIdOrKey
     * @param string|null $accountId    Assigns an issue to a user.
     *
     * @throws JiraException
     *
     * @return string
     */
    public function changeAssigneeByAccountId($issueIdOrKey, $accountId)
    {
        $this->log->info("changeAssigneeByAccountId=\n");

        $ar = ['accountId' => $accountId];

        $data = json_encode($ar);

        $ret = $this->exec($this->uri."/$issueIdOrKey/assignee", $data, 'PUT');

        $this->log->info('change assignee of '.$issueIdOrKey.' to '.$accountId.' result='.var_export($ret, true));

        return $ret;
    }

    /**
     * Delete a issue.
     *
     * @param string|int $issueIdOrKey Issue id or key
     * @param array      $paramArray   Query Parameter key-value Array.
     *
     * @throws JiraException
     *
     * @return string|bool
     */
    public function deleteIssue($issueIdOrKey, $paramArray = [])
    {
        $this->log->info("deleteIssue=\n");

        $queryParam = '?'.http_build_query($paramArray);

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

        $this->log->info('delete issue '.$issueIdOrKey.' result='.var_export($ret, true));

        return $ret;
    }

    /**
     * Get a list of the transitions possible for this issue by the current user, along with fields that are required and their types.
     *
     * @param string|int $issueIdOrKey Issue id or key
     * @param array      $paramArray   Query Parameter key-value Array.
     *
     * @throws JiraException
     *
     * @return Transition[] array of Transition class
     */
    public function getTransition($issueIdOrKey, $paramArray = [])
    {
        $queryParam = '?'.http_build_query($paramArray);

        $ret = $this->exec($this->uri."/$issueIdOrKey/transitions".$queryParam);

        $this->log->debug('getTransitions result='.var_export($ret, true));

        $data = json_encode(json_decode($ret)->transitions);

        $transitions = $this->json_mapper->mapArray(
           json_decode($data), new \ArrayObject(), '\JiraRestApi\Issue\Transition'
        );

        return $transitions;
    }

    /**
     * find transition id by transition's to field name(aka 'Resolved').
     *
     * @param string|int $issueIdOrKey
     * @param string     $transitionToName
     *
     * @throws JiraException
     *
     * @return string
     */
    public function findTransitonId($issueIdOrKey, $transitionToName)
    {
        $this->log->debug('findTransitonId=');

        $ret = $this->getTransition($issueIdOrKey);

        foreach ($ret as $trans) {
            $toName = $trans->to->name;

            $this->log->debug('getTransitions result='.var_export($ret, true));

            if (strcmp($toName, $transitionToName) == 0) {
                return $trans->id;
            }
        }

        // transition keyword not found
        throw new JiraException("Transition name '$transitionToName' not found on JIRA Server.");
    }

    /**
     * Perform a transition on an issue.
     *
     * @param string|int $issueIdOrKey Issue id or key
     * @param Transition $transition
     *
     * @throws JiraException
     *
     * @return string|null nothing - if transition was successful return http 204(no contents)
     */
    public function transition($issueIdOrKey, $transition)
    {
        $this->log->debug('transition='.var_export($transition, true));

        if (!isset($transition->transition['id'])) {
            $transition->transition['id'] = $this->findTransitonId($issueIdOrKey, $transition->transition['name']);
        }

        $data = json_encode($transition);

        $this->log->debug("transition req=$data\n");

        $ret = $this->exec($this->uri."/$issueIdOrKey/transitions", $data, 'POST');

        $this->log->debug('getTransitions result='.var_export($ret, true));

        return $ret;
    }

    /**
     * Search issues.
     *
     * @param string $jql
     * @param int    $startAt
     * @param int    $maxResults
     * @param array  $fields
     * @param array  $expand
     * @param bool   $validateQuery
     *
     * @throws JiraException
     * @throws \JsonMapper_Exception
     *
     * @return IssueSearchResult|object
     */
    public function search($jql, $startAt = 0, $maxResults = 15, $fields = [], $expand = [], $validateQuery = true)
    {
        $data = json_encode([
            'jql'           => $jql,
            'startAt'       => $startAt,
            'maxResults'    => $maxResults,
            'fields'        => $fields,
            'expand'        => $expand,
            'validateQuery' => $validateQuery,
        ]);

        $ret = $this->exec('search', $data, 'POST');
        $json = json_decode($ret);

        $result = null;
        if ($this->isRestApiV3()) {
            $result = $this->json_mapper->map(
                $json, new IssueSearchResultV3()
            );
        } else {
            $result = $this->json_mapper->map(
                $json, new IssueSearchResult()
            );
        }

        return $result;
    }

    /**
     * get TimeTracking info.
     *
     * @param string|int $issueIdOrKey
     *
     * @throws JiraException
     * @throws \JsonMapper_Exception
     *
     * @return TimeTracking
     */
    public function getTimeTracking($issueIdOrKey)
    {
        $ret = $this->exec($this->uri."/$issueIdOrKey", null);
        $this->log->debug("getTimeTracking res=$ret\n");

        $issue = $this->json_mapper->map(
             json_decode($ret), new Issue()
        );

        return $issue->fields->timeTracking;
    }

    /**
     * TimeTracking issues.
     *
     * @param string|int   $issueIdOrKey Issue id or key
     * @param TimeTracking $timeTracking
     *
     * @throws JiraException
     *
     * @return string
     */
    public function timeTracking($issueIdOrKey, $timeTracking)
    {
        $array = [
            'update' => [
                'timetracking' => [
                    ['edit' => $timeTracking],
                ],
            ],
        ];

        $data = json_encode($array);

        $this->log->debug("TimeTracking req=$data\n");

        // if success, just return HTTP 201.
        $ret = $this->exec($this->uri."/$issueIdOrKey", $data, 'PUT');

        return $ret;
    }

    /**
     * get getWorklog.
     *
     * @param string|int $issueIdOrKey
     *
     * @throws JiraException
     * @throws \JsonMapper_Exception
     *
     * @return PaginatedWorklog|object
     */
    public function getWorklog($issueIdOrKey)
    {
        $ret = $this->exec($this->uri."/$issueIdOrKey/worklog");
        $this->log->debug("getWorklog res=$ret\n");
        $worklog = $this->json_mapper->map(
            json_decode($ret), new PaginatedWorklog()
        );

        return $worklog;
    }

    /**
     * get getWorklog by Id.
     *
     * @param string|int $issueIdOrKey
     * @param int        $workLogId
     *
     * @throws JiraException
     * @throws \JsonMapper_Exception
     *
     * @return Worklog|object PaginatedWorklog object
     */
    public function getWorklogById($issueIdOrKey, $workLogId)
    {
        $ret = $this->exec($this->uri."/$issueIdOrKey/worklog/$workLogId");
        $this->log->debug("getWorklogById res=$ret\n");
        $worklog = $this->json_mapper->map(
            json_decode($ret), new Worklog()
        );

        return $worklog;
    }

    /**
     * add work log to issue.
     *
     * @param string|int     $issueIdOrKey
     * @param Worklog|object $worklog
     *
     * @throws JiraException
     * @throws \JsonMapper_Exception
     *
     * @return Worklog|object Worklog Object
     */
    public function addWorklog($issueIdOrKey, $worklog)
    {
        $this->log->info("addWorklog=\n");

        $data = json_encode($worklog);
        $url = $this->uri."/$issueIdOrKey/worklog";
        $type = 'POST';

        $ret = $this->exec($url, $data, $type);

        $ret_worklog = $this->json_mapper->map(
           json_decode($ret), new Worklog()
        );

        return $ret_worklog;
    }

    /**
     * edit the worklog.
     *
     * @param string|int     $issueIdOrKey
     * @param Worklog|object $worklog
     * @param string|int     $worklogId
     *
     * @throws JiraException
     * @throws \JsonMapper_Exception
     *
     * @return Worklog|object
     */
    public function editWorklog($issueIdOrKey, $worklog, $worklogId)
    {
        $this->log->info("editWorklog=\n");

        $data = json_encode($worklog);
        $url = $this->uri."/$issueIdOrKey/worklog/$worklogId";
        $type = 'PUT';

        $ret = $this->exec($url, $data, $type);

        $ret_worklog = $this->json_mapper->map(
            json_decode($ret), new Worklog()
        );

        return $ret_worklog;
    }

    /**
     * delete worklog.
     *
     * @param string|int $issueIdOrKey
     * @param string|int $worklogId
     *
     * @throws JiraException
     *
     * @return bool
     */
    public function deleteWorklog($issueIdOrKey, $worklogId)
    {
        $this->log->info("deleteWorklog=\n");

        $url = $this->uri."/$issueIdOrKey/worklog/$worklogId";
        $type = 'DELETE';

        $ret = $this->exec($url, null, $type);

        return (bool)$ret;
    }

    /**
     * Get all priorities.
     *
     * @throws JiraException
     *
     * @return Priority[] array of priority class
     */
    public function getAllPriorities()
    {
        $ret = $this->exec('priority', null);

        $priorities = $this->json_mapper->mapArray(
             json_decode($ret, false), new \ArrayObject(), '\JiraRestApi\Issue\Priority'
        );

        return $priorities;
    }

    /**
     * Get priority by id.
     * throws  HTTPException if the priority is not found, or the calling user does not have permission or view it.
     *
     * @param string|int $priorityId Id of priority.
     *
     * @throws JiraException
     * @throws \JsonMapper_Exception
     *
     * @return Priority|object priority
     */
    public function getPriority($priorityId)
    {
        $ret = $this->exec("priority/$priorityId", null);

        $this->log->info('Result='.$ret);

        $prio = $this->json_mapper->map(
             json_decode($ret), new Priority()
        );

        return $prio;
    }

    /**
     * Get priority by id.
     * throws HTTPException if the priority is not found, or the calling user does not have permission or view it.
     *
     * @param string|int $priorityId Id of priority.
     *
     * @throws JiraException
     * @throws \JsonMapper_Exception
     *
     * @return Priority|object priority
     */
    public function getCustomFields($priorityId)
    {
        $ret = $this->exec("priority/$priorityId", null);

        $this->log->info('Result='.$ret);

        $prio = $this->json_mapper->map(
            json_decode($ret), new Priority()
        );

        return $prio;
    }

    /**
     * get watchers.
     *
     * @param $issueIdOrKey
     *
     * @throws JiraException
     *
     * @return Reporter[]
     */
    public function getWatchers($issueIdOrKey)
    {
        $this->log->info("getWatchers=\n");

        $url = $this->uri."/$issueIdOrKey/watchers";

        $ret = $this->exec($url, null);

        $watchers = $this->json_mapper->mapArray(
            json_decode($ret, false)->watchers, new \ArrayObject(), '\JiraRestApi\Issue\Reporter'
        );

        return $watchers;
    }

    /**
     * add watcher to issue.
     *
     * @param string|int $issueIdOrKey
     * @param string     $watcher      watcher id
     *
     * @throws JiraException
     *
     * @return bool
     */
    public function addWatcher($issueIdOrKey, $watcher)
    {
        $this->log->info("addWatcher=\n");

        $data = json_encode($watcher);
        $url = $this->uri."/$issueIdOrKey/watchers";
        $type = 'POST';

        $this->exec($url, $data, $type);

        return $this->http_response == 204 ? true : false;
    }

    /**
     * remove watcher from issue.
     *
     * @param string|int $issueIdOrKey
     * @param string     $watcher      watcher id
     *
     * @throws JiraException
     *
     * @return bool
     */
    public function removeWatcher($issueIdOrKey, $watcher)
    {
        $this->log->addInfo("removeWatcher=\n");

        $ret = $this->exec($this->uri."/$issueIdOrKey/watchers/?username=$watcher", '', 'DELETE');

        $this->log->addInfo('remove watcher '.$issueIdOrKey.' result='.var_export($ret, true));

        return $this->http_response == 204 ? true : false;
    }

    /**
     * remove watcher from issue by watcher account id.
     *
     * @param string|int $issueIdOrKey
     * @param string     $accountId    Watcher account id.
     *
     * @throws JiraException
     *
     * @return bool
     */
    public function removeWatcherByAccountId($issueIdOrKey, $accountId)
    {
        $this->log->info("removeWatcher=\n");

        $ret = $this->exec($this->uri."/$issueIdOrKey/watchers/?accountId=$accountId", '', 'DELETE');

        $this->log->info('remove watcher '.$issueIdOrKey.' result='.var_export($ret, true));

        return $this->http_response == 204 ? true : false;
    }

    /**
     * Get the meta data for creating issues.
     *
     * @param array $paramArray Possible keys for $paramArray: 'projectIds', 'projectKeys', 'issuetypeIds', 'issuetypeNames'.
     * @param bool  $expand     Retrieve all issue fields and values
     *
     * @throws JiraException
     *
     * @return object array of meta data for creating issues.
     */
    public function getCreateMeta($paramArray = [], $expand = true)
    {
        $paramArray['expand'] = ($expand) ? 'projects.issuetypes.fields' : null;
        $paramArray = array_filter($paramArray);

        $queryParam = '?'.http_build_query($paramArray);

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

        return json_decode($ret);
    }

    /**
     * returns the metadata(include custom field) for an issue.
     *
     * @param string $idOrKey                issue id or key
     * @param bool   $overrideEditableFlag   Allows retrieving edit metadata for fields in non-editable status
     * @param bool   $overrideScreenSecurity Allows retrieving edit metadata for the fields hidden on Edit screen.
     *
     * @throws JiraException
     *
     * @return array of custom fields
     *
     * @see https://confluence.atlassian.com/jirakb/how-to-retrieve-available-options-for-a-multi-select-customfield-via-jira-rest-api-815566715.html How to retrieve available options for a multi-select customfield via JIRA REST API
     * @see https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-issue-issueIdOrKey-editmeta-get
     */
    public function getEditMeta($idOrKey, $overrideEditableFlag = false, $overrideScreenSecurity = false)
    {
        $queryParam = '?'.http_build_query([
            'overrideEditableFlag'   => $overrideEditableFlag,
            'overrideScreenSecurity' => $overrideScreenSecurity,
        ]);

        $uri = sprintf('%s/%s/editmeta', $this->uri, $idOrKey).$queryParam;

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

        $metas = json_decode($ret, true);

        // extract only custom field(startWith customefield_XXXXX)
        $cfs = array_filter($metas['fields'], function ($key) {
            $pos = strpos($key, 'customfield');

            return $pos !== false;
        }, ARRAY_FILTER_USE_KEY);

        return $cfs;
    }

    /**
     * Sends a notification (email) to the list or recipients defined in the request.
     *
     * @param string|int $issueIdOrKey Issue id Or Key
     * @param Notify     $notify
     *
     * @throws JiraException
     *
     * @see https://docs.atlassian.com/software/jira/docs/api/REST/latest/#api/2/issue-notify
     */
    public function notify($issueIdOrKey, $notify)
    {
        $full_uri = $this->uri."/$issueIdOrKey/notify";

        // set self value
        foreach ($notify->to['groups'] as &$g) {
            $g['self'] = $this->getConfiguration()->getJiraHost().'/rest/api/2/group?groupname='.$g['name'];
        }
        foreach ($notify->restrict['groups'] as &$g) {
            $g['self'] = $this->getConfiguration()->getJiraHost().'/rest/api/2/group?groupname='.$g['name'];
        }

        $data = json_encode($notify, JSON_UNESCAPED_SLASHES);

        $this->log->debug("notify=$data\n");

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

        if ($ret !== true) {

            throw new JiraException('notify failed: response code='.$ret);
        }
    }

    /**
     * Get a remote issue links on the issue.
     *
     * @param string|int $issueIdOrKey Issue id Or Key
     *
     * @throws JiraException
     *
     * @return array array os RemoteIssueLink class
     *
     * @see https://developer.atlassian.com/server/jira/platform/jira-rest-api-for-remote-issue-links/
     * @see https://docs.atlassian.com/software/jira/docs/api/REST/latest/#api/2/issue-getRemoteIssueLinks
     */
    public function getRemoteIssueLink($issueIdOrKey)
    {
        $full_uri = $this->uri."/$issueIdOrKey/remotelink";

        $ret = $this->exec($full_uri, null);

        $rils = $this->json_mapper->mapArray(
            json_decode($ret, false), new \ArrayObject(), RemoteIssueLink::class
        );

        return $rils;
    }

    /**
     * @param string|int      $issueIdOrKey
     * @param RemoteIssueLink $ril
     *
     * @throws JiraException
     * @throws \JsonMapper_Exception
     *
     * @return object
     */
    public function createOrUpdateRemoteIssueLink($issueIdOrKey, RemoteIssueLink $ril)
    {
        $full_uri = $this->uri."/$issueIdOrKey/remotelink";

        $data = json_encode($ril, JSON_UNESCAPED_SLASHES);

        $this->log->debug("create remoteIssueLink=$data\n");

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

        $res = $this->json_mapper->map(
            json_decode($ret), new RemoteIssueLink()
        );

        return $res;
    }

    /**
     * @param string|int $issueIdOrKey
     * @param string|int $globalId
     *
     * @throws JiraException
     *
     * @return string|bool
     */
    public function removeRemoteIssueLink($issueIdOrKey, $globalId)
    {
        $query = http_build_query(['globalId' => $globalId]);

        $full_uri = sprintf('%s/%s/remotelink?%s', $this->uri, $issueIdOrKey, $query);

        $ret = $this->exec($full_uri, '', 'DELETE');

        $this->log->info(
            sprintf(
                'delete remote issue link for issue "%s" with globalId "%s". Result=%s',
                $issueIdOrKey,
                $globalId,
                var_export($ret, true)
            )
        );

        return $ret;
    }

    /**
     * get all issue security schemes.
     *
     * @throws JiraException
     * @throws \JsonMapper_Exception
     *
     * @return SecurityScheme[] array of SecurityScheme class
     */
    public function getAllIssueSecuritySchemes()
    {
        $url = '/issuesecurityschemes';

        $ret = $this->exec($url);

        $data = json_decode($ret, true);

        // extract schem field
        $schemes = json_decode(json_encode($data['issueSecuritySchemes']), false);

        $res = $this->json_mapper->mapArray(
            $schemes, new \ArrayObject(), '\JiraRestApi\Issue\SecurityScheme'
        );

        return $res;
    }

    /**
     *  get issue security scheme.
     *
     * @param int $securityId security scheme id
     *
     * @throws JiraException
     * @throws \JsonMapper_Exception
     *
     * @return SecurityScheme SecurityScheme
     */
    public function getIssueSecuritySchemes($securityId)
    {
        $url = '/issuesecurityschemes/'.$securityId;

        $ret = $this->exec($url);

        $res = $this->json_mapper->map(
            json_decode($ret), new SecurityScheme()
        );

        return $res;
    }

    /**
     * convenient wrapper function for add or remove labels.
     *
     * @param string|int $issueIdOrKey
     * @param array|null $addLablesParam
     * @param array|null $removeLabelsParam
     * @param bool       $notifyUsers
     *
     * @throws JiraException
     *
     * @return Issue|object class
     */
    public function updateLabels($issueIdOrKey, $addLablesParam, $removeLabelsParam, $notifyUsers = true)
    {
        $labels = [];
        foreach ($addLablesParam as $a) {
            array_push($labels, ['add' => $a]);
        }

        foreach ($removeLabelsParam as $r) {
            array_push($labels, ['remove' => $r]);
        }

        $postData = json_encode([
            'update' => [
                'labels' => $labels,
            ],
        ], JSON_UNESCAPED_UNICODE);

        $this->log->info("Update labels=\n".$postData);

        $queryParam = '?'.http_build_query(['notifyUsers' => $notifyUsers]);

        $ret = $this->exec($this->uri."/$issueIdOrKey".$queryParam, $postData, 'PUT');

        return $ret;

    }

    /**
     * convenient wrapper function for add or remove fix versions.
     *
     * @param string|int $issueIdOrKey
     * @param array|null $addFixVersionsParam
     * @param array|null $removeFixVersionsParam
     * @param bool       $notifyUsers
     *
     * @throws JiraException
     *
     * @return Issue|object class
     */
    public function updateFixVersions($issueIdOrKey, $addFixVersionsParam, $removeFixVersionsParam, $notifyUsers = true)
    {
        $fixVersions = [];
        foreach ($addFixVersionsParam as $a) {
            array_push($fixVersions, ['add' => ['name' => $a]]);
        }

        foreach ($removeFixVersionsParam as $r) {
            array_push($fixVersions, ['remove' => ['name' => $r]]);
        }

        $postData = json_encode([
            'update' => [
                'fixVersions' => $fixVersions,
            ],
        ], JSON_UNESCAPED_UNICODE);

        $this->log->info("Update fixVersions=\n".$postData);

        $queryParam = '?'.http_build_query(['notifyUsers' => $notifyUsers]);

        $ret = $this->exec($this->uri."/$issueIdOrKey".$queryParam, $postData, 'PUT');

        return $ret;

    }
}

lesstif / php-jira-rest-client

Pull Request — master (#303)

IssueService::update() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
