VersionService::get() - Code Metrics - Inspection of "Merge pull request #203 from marvelig/feature/Vers..." - lesstif/php-jira-rest-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( dc3cca...ad625a )

by KwangSeob

created 2018-09-20 12:41 UTC

VersionService::get() A

↳ Parent: VersionService

Complexity

Conditions	1
Paths	1

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	7
nc	1
nop	1
dl	0
loc	12
rs	10
c	0
b	0
f	0

<?php

namespace JiraRestApi\Version;

use JiraRestApi\Issue\Version;
use JiraRestApi\Issue\VersionUnresolvedCount;
use JiraRestApi\Issue\VersionIssueCounts;
use JiraRestApi\JiraException;
use JiraRestApi\Project\ProjectService;

class VersionService extends \JiraRestApi\JiraClient
{
    private $uri = '/version';

    /**
     * Function to create a new project version.
     *
     * @param Version|array $version
     *
     * @throws \JiraRestApi\JiraException
     * @throws \JsonMapper_Exception
     *
     * @return Version Version class
     */
    public function create($version)
    {
        if ($version->releaseDate instanceof \DateTime) {
            $version->releaseDate = $version->releaseDate->format('Y-m-d');

        }
        $data = json_encode($version);

        $this->log->addInfo("Create Version=\n".$data);

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

        return $this->json_mapper->map(
            json_decode($ret), new Version()
        );
    }

    /**
     * Modify a version's sequence within a project.
     *
     * @param $version
     *
     * @throws JiraException
     */
    public function move($version)
    public function move(/** @scrutinizer ignore-unused */ $version)
    {
        throw new JiraException('move version not yet implemented');
    }

    /**
     * get project version.
     *
     * @param $id version id
     *
     * @return Version
     *
     * @see ProjectService::getVersions()
     */
    public function get($id)
    {
        $ret = $this->exec($this->uri.'/'.$id);

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

        $json = json_decode($ret);
        $results = array_map(function ($elem) {
            return $this->json_mapper->map($elem, new ProjectType());
filter:
    dependency_paths: ["lib/*"]
        }, $json);

        return $results;

    }

    /**
     * @author Martijn Smidt <[email protected]>
     *
     * @param Version $version
     *
     * @throws JiraException
     *
     * @return Version
     */
    public function update(Version $version)
    {
        if (!$version->id || !is_numeric($version->id)) {
            throw new JiraException($version->id.' is not a valid version id.');
        }

        if ($version->releaseDate instanceof \DateTime) {
            $version->releaseDate = $version->releaseDate->format('Y-m-d');

        }

        //Only one of 'releaseDate' and 'userReleaseDate' can be specified when editing a version."
        $version->userReleaseDate = null;

        $data = json_encode($version);
        $ret = $this->exec($this->uri.'/'.$version->id, $data, 'PUT');

        return $this->json_mapper->map(
            json_decode($ret), new Version()
        );
    }

    /**
     * @author Martijn Smidt <[email protected]>
     *
     * @param Version      $version
     * @param Version|bool $moveAffectedIssuesTo
     * @param Version|bool $moveFixIssuesTo
     *
     * @throws JiraException
     *
     * @return bool
     */
    public function delete(Version $version, $moveAffectedIssuesTo = false, $moveFixIssuesTo = false)
    {
        if (!$version->id || !is_numeric($version->id)) {
            throw new JiraException($version->id.' is not a valid version id.');
        }

        $data = [];

        if ($moveAffectedIssuesTo && $moveAffectedIssuesTo instanceof Version) {
            $data['moveAffectedIssuesTo'] = $moveAffectedIssuesTo->name;
        }

        if ($moveFixIssuesTo && $moveFixIssuesTo instanceof Version) {
            $data['moveFixIssuesTo'] = $moveFixIssuesTo->name;
        }

        $ret = $this->exec($this->uri.'/'.$version->id, json_encode($data), 'DELETE');

        return $ret;

    }

    public function merge($ver)
    public function merge(/** @scrutinizer ignore-unused */ $ver)
    {
        throw new JiraException('merge version not yet implemented');
    }

    /**
     * Returns a bean containing the number of fixed in and affected issues for the given version.
     *
     * @param Version $version
     *
     * @throws JiraException
     *
     * @see https://docs.atlassian.com/jira/REST/server/#api/2/version-getVersionRelatedIssues
     */
    public function getRelatedIssues(Version $version)
    {
        if (!$version->id || !is_numeric($version->id)) {
            throw new JiraException($version->id.' is not a valid version id.');
        }

        $ret = $this->exec($this->uri.'/'.$version->id.'/relatedIssueCounts');

        return $this->json_mapper->map(
            json_decode($ret),
            new VersionIssueCounts()
        );
    }

    /**
     * Returns a bean containing the number of unresolved issues for the given version.
     *
     * @param Version $version
     *
     * @throws JiraException
     *
     * @see https://docs.atlassian.com/software/jira/docs/api/REST/7.6.1/#api/2/version-getVersionUnresolvedIssues
     *
     * @return VersionUnresolvedCount
     */
    public function getUnresolvedIssues(Version $version)
    {
        if (!$version->id || !is_numeric($version->id)) {
            throw new JiraException($version->id.' is not a valid version id.');
        }

        $ret = $this->exec($this->uri.'/'.$version->id.'/unresolvedIssueCount');

        return $this->json_mapper->map(
            json_decode($ret),
            new VersionUnresolvedCount()
        );
    }
}


lesstif / php-jira-rest-client

Push — master ( dc3cca...ad625a )

VersionService::get() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like