Manavo\DoneDone\Issue

Complexity

Total Complexity

30

Size/Duplication

Total Lines	345
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Test Coverage

Coverage

95.9%

Importance

Changes	13
Bugs	2	Features	1

20 Methods

Rating	Name	Duplication	Size	Complexity
A	setDescription()	0	4	1
A	setFixer()	0	4	1
A	setPriorityLevel()	0	4	1
A	setTester()	0	4	1
A	setTitle()	0	4	1
A	addAttachment()	0	4	1
A	__construct()	0	6	1
A	setDueDate()	0	7	2
A	setUserIdsToCc()	0	8	2
A	setTags()	0	8	2
A	addComment()	0	11	1
A	availableReassignees()	0	10	1
A	get()	0	6	1
A	availableStatuses()	0	10	1
A	updateStatus()	0	11	1
A	updatePriorityLevel()	0	11	1
A	updateTester()	0	11	1
A	updateFixer()	0	11	1
A	update()	0	20	3
B	toArray()	0	31	6

<?php

namespace Manavo\DoneDone;

class Issue
{
    /**
     * @var Client
     */
    private $client;

    /**
     * @var int
     */
    private $projectId;

    /**
     * @var int
     */
    private $id;

    private $title = null;
    private $priorityLevel = null;
    private $fixer = null;
    private $tester = null;
    private $description = null;
    private $dueDate = null;
    private $attachments = [];
    private $userIdsToCc = null;
    private $tags = null;

    /**
     * @param Client $client
     * @param int    $projectId
     * @param int    $id
     */
    function __construct($client = null, $projectId = null, $id = null)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $this->client = $client;
        $this->projectId = $projectId;
        $this->id = $id;
    }

    /**
     * @param string $description
     */
    public function setDescription($description)
    {
        $this->description = $description;
    }

    /**
     * @param int $fixer
     */
    public function setFixer($fixer)
    {
        $this->fixer = $fixer;
    }

    /**
     * @param int $priorityLevel
     */
    public function setPriorityLevel($priorityLevel)
    {
        $this->priorityLevel = $priorityLevel;
    }

    /**
     * @param int $tester
     */
    public function setTester($tester)
    {
        $this->tester = $tester;
    }

    /**
     * @param string $title
     */
    public function setTitle($title)
    {
        $this->title = $title;
    }

    /**
     * Due date. Accepts Unix timestamp, or a formatted date string.
     *
     * Examples: 2014-09-20 16:40:31, 1411231231
     *
     * @param string|int $dueDate
     */
    public function setDueDate($dueDate)
    {
        if (is_numeric($dueDate)) {
            $dueDate = date('Y-m-d H:i:s', $dueDate);
        }
        $this->dueDate = $dueDate;
    }

    /**
     * Add an attachment to the issue
     *
     * @param string $file
     */
    public function addAttachment($file)
    {
        $this->attachments[] = $file;
    }

    /**
     * Set user IDs to CC. Can be an array of IDs, a comma separated list of
     * IDs, or just a single ID.
     *
     * @param array|string|int $ids
     */
    public function setUserIdsToCc($ids)
    {
        if (is_array($ids)) {
            $ids = implode(',', $ids);
        }

        $this->userIdsToCc = $ids;
    }

    /**
     * Set tags. Can be an array of tags, a comma separated list of
     * tags, or just a single tag.
     *
     * @param array|string $tags
     */
    public function setTags($tags)
    {
        if (is_array($tags)) {
            $tags = implode(',', $tags);
        }

        $this->tags = $tags;
    }

    /**
     * Add a new comment to the issue
     *
     * @param Comment $comment
     *
     * @return array
     */
    public function addComment($comment)
    {
        return $this->client->post(
            sprintf(
                'projects/%d/issues/%d/comments',
                $this->projectId,
                $this->id
            ),
            $comment->toArray()
        );
    }

    /**
     * Get a list of people who can be cc’d or assigned as the fixer or tester to the issue
     *
     * @return array
     */
    public function availableReassignees()
    {
        return $this->client->get(
            sprintf(
                'projects/%d/issues/%d/people/available_for_reassignment',
                $this->projectId,
                $this->id
            )
        );
    }

    /**
     * Get the details of this issue
     *
     * @return array
     */
    public function get()
    {
        return $this->client->get(
            sprintf('projects/%d/issues/%d', $this->projectId, $this->id)
        );
    }

    /**
     * Get a list of issue statuses the authenticated user may update the issue
     *
     * @return array
     */
    public function availableStatuses()
    {
        return $this->client->get(
            sprintf(
                'projects/%d/issues/%d/statuses/available_to_change_to',
                $this->projectId,
                $this->id
            )
        );
    }

    /**
     * Update the status of this issue
     *
     * @param int         $newStatus
     * @param string|null $comment
     * @param array       $attachments
     *
     * @return array
     */
    public function updateStatus(
        $newStatus,
        $comment = null,
        $attachments = []
    ) {
        $data = [
            'new_status_id' => $newStatus,
        ];

        return $this->update('status', $data, $comment, $attachments);
    }
    /**
     * Update the priority level of this issue
     *
     * @param int         $newLevel
     * @param string|null $comment
     * @param array       $attachments
     *
     * @return array
     */
    public function updatePriorityLevel(
        $newLevel,
        $comment = null,
        $attachments = []
    ) {
        $data = [
            'new_priority_level_id' => $newLevel,
        ];

        return $this->update('priority_level', $data, $comment, $attachments);
    }

    /**
     * Update the tester of this issue
     *
     * @param int         $newTester
     * @param string|null $comment
     * @param array       $attachments
     *
     * @return array
     */
    public function updateTester(
        $newTester,
        $comment = null,
        $attachments = []
    ) {
        $data = [
            'new_tester_id' => $newTester,
        ];

        return $this->update('tester', $data, $comment, $attachments);
    }

    /**
     * Update the fixer of this issue
     *
     * @param int         $newFixer
     * @param string|null $comment
     * @param array       $attachments
     *
     * @return array
     */
    public function updateFixer(
        $newFixer,
        $comment = null,
        $attachments = []
    ) {
        $data = [
            'new_fixer_id' => $newFixer,
        ];

        return $this->update('fixer', $data, $comment, $attachments);
    }

    /**
     * @param string $endpoint
     * @param array  $data
     * @param string $comment
     * @param array  $attachments
     *
     * @return array
     */
    private function update($endpoint, $data, $comment, $attachments)
    {
        if ($comment) {
            $data['comment'] = $comment;
        }

        foreach ($attachments as $index => $attachment) {
            $data['attachment-' . $index] = fopen($attachment, 'r');
        }

        return $this->client->put(
            sprintf(
                'projects/%d/issues/%d/%s',
                $this->projectId,
                $this->id,
                $endpoint
            ),
            $data
        );
    }

    /**
     * @return array
     */
    public function toArray()
    {
        $data = [
            'title'             => $this->title,
            'priority_level_id' => $this->priorityLevel,
            'fixer_id'          => $this->fixer,
            'tester_id'         => $this->tester,
        ];

        if ($this->description) {
            $data['description'] = $this->description;
        }

        if ($this->userIdsToCc) {
            $data['user_ids_to_cc'] = $this->userIdsToCc;
        }

        if ($this->dueDate) {
            $data['due_date'] = $this->dueDate;
        }

        if ($this->tags) {
            $data['tags'] = $this->tags;
        }

        foreach ($this->attachments as $index => $attachment) {
            $data['attachment-' . $index] = fopen($attachment, 'r');
        }

        return $data;
    }

}