Fr3nch13\Jira\View\Helper\JiraHelper

Complexity

Total Complexity

8

Size/Duplication

Total Lines	103
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	5
Bugs	0	Features	2

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getVersions()	0	3	1
A	getOpenBugs()	0	3	1
A	getOpenIssues()	0	3	1
A	__construct()	0	5	1
A	getBugs()	0	3	1
A	getIssues()	0	3	1
A	getInfo()	0	5	1
A	getIssue()	0	3	1

<?php
declare(strict_types=1);

/**
 * JiraHelper
 */

namespace Fr3nch13\Jira\View\Helper;

use Cake\View\Helper;
use Cake\View\View;
use Fr3nch13\Jira\Lib\JiraProject;

/**
 * Jira Helper
 *
 * Helper to write out stuff about your jira project.
 *
 * @property \Cake\View\Helper\UrlHelper $Url
 * @property \Cake\View\Helper\HtmlHelper $Html
 */
class JiraHelper extends Helper
{
    /**
     * List of loaded helpers.
     *
     * @var array<string>
     */
    public $helpers = ['Url', 'Html'];

    /**
     * Contains the loaded Jira Project object.
     *
     * @var \Fr3nch13\Jira\Lib\JiraProject
     */
    protected $JiraProject;

    /**
     * Initialize the helper
     *
     * @param \Cake\View\View $View The view object
     * @param array<string, mixed> $config Helper config settings
     * @return void
     */
    public function __construct(View $View, array $config = [])
    {
        parent::__construct($View, $config);

        $this->JiraProject = new JiraProject();
    }

    /**
     * Get the information about the Jira Project
     *
     * @return \JiraRestApi\Project\Project Object containing the information about your project.
     * @throws \Fr3nch13\Jira\Exception\MissingProjectException If the project can't be found.
     */
    public function getInfo()
    {
        $info = $this->JiraProject->getInfo();

        return $info;
    }

    /**
     * Gets a list of all versions within your project.
     *
     * @return array<\JiraRestApi\Issue\Version> A list of version objects.
     */
    public function getVersions(): array
    {
        return $this->JiraProject->getVersions();
    }

    /**
     * Gets a list of all issues within your project.
     *
     * @return \JiraRestApi\Issue\IssueSearchResult|\JiraRestApi\Issue\IssueSearchResultV3 A list of issue objects.
     */
    public function getIssues(): ?\JiraRestApi\Issue\IssueSearchResult
    {
        return $this->JiraProject->getIssues();
    }

    /**
     * Gets a list of all open issues within your project.
     *
     * @return \JiraRestApi\Issue\IssueSearchResult|\JiraRestApi\Issue\IssueSearchResultV3 A list of issue objects.
     */
    public function getOpenIssues(): ?\JiraRestApi\Issue\IssueSearchResult
    {
        return $this->JiraProject->getOpenIssues();
    }

    /**
     * Gets info on a particular issue within your project.
     *
     * @param int $id The issue id. The integer part without the project key.
     * @return \JiraRestApi\Issue\Issue|\JiraRestApi\Issue\IssueV3 the object that has the info of that issue.
     * @throws \Fr3nch13\Jira\Exception\MissingIssueException If the project's issue can't be found.
     */
    public function getIssue($id = null)
    {
        return $this->JiraProject->getIssue($id);
    }

    /**
     * Gets a list of all issues that are bugs within your project.
     *
     * @return \JiraRestApi\Issue\IssueSearchResult|\JiraRestApi\Issue\IssueSearchResultV3 A list of issue objects.
     */
    public function getBugs(): ?\JiraRestApi\Issue\IssueSearchResult
    {
        return $this->JiraProject->getBugs();
    }

    /**
     * Gets a list of all open issues that are bugs within your project.
     *
     * @return \JiraRestApi\Issue\IssueSearchResult|\JiraRestApi\Issue\IssueSearchResultV3 A list of issue objects.
     */
    public function getOpenBugs(): ?\JiraRestApi\Issue\IssueSearchResult
    {
        return $this->JiraProject->getOpenBugs();
    }
}