FlexyProject\GitHub\Receiver\Issues\Comments

Complexity

Total Complexity

7

Size/Duplication

Total Lines	113
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	listIssueComments()	0	5	1
A	listRepositoryComments()	0	11	1
A	getComment()	0	5	1
A	createComment()	0	7	1
A	editComment()	0	7	1
A	deleteComment()	0	11	2

<?php
namespace FlexyProject\GitHub\Receiver\Issues;

use Symfony\Component\HttpFoundation\Request;
use FlexyProject\GitHub\AbstractApi;

/**
 * The Trees API class provides access to Issues's comments.
 *
 * @link    https://developer.github.com/v3/issues/comments/
 * @package FlexyProject\GitHub\Receiver\Issues
 */
class Comments extends AbstractIssues
{

    /**
     * List comments on an issue
     *
     * @link https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue
     *
     * @param int $number
     *
     * @return array
     */
    public function listIssueComments(int $number): array
    {
        return $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/issues/:number/comments',
            $this->getIssues()->getOwner(), $this->getIssues()->getRepo(), $number));
    }

    /**
     * List comments in a repository
     *
     * @link https://developer.github.com/v3/issues/comments/#list-comments-in-a-repository
     *
     * @param string $sort
     * @param string $direction
     * @param string $since
     *
     * @return array
     */
    public function listRepositoryComments(string $sort = AbstractApi::SORT_CREATED,
                                           string $direction = AbstractApi::DIRECTION_DESC,
                                           string $since = 'now'): array
    {
        return $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/issues/comments?:args',
            $this->getIssues()->getOwner(), $this->getIssues()->getRepo(), http_build_query([
                'sort'      => $sort,
                'direction' => $direction,
                'since'     => $since
            ])));
    }

    /**
     * Get a single comment
     *
     * @link https://developer.github.com/v3/issues/comments/#get-a-single-comment
     *
     * @param int $id
     *
     * @return array
     */
    public function getComment(int $id): array
    {
        return $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/issues/comments/:id',
            $this->getIssues()->getOwner(), $this->getIssues()->getRepo(), $id));
    }

    /**
     * Create a comment
     *
     * @link https://developer.github.com/v3/issues/comments/#create-a-comment
     *
     * @param int    $number
     * @param string $body
     *
     * @return array
     */
    public function createComment(int $number, string $body): array
    {
        return $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/issues/:number/comments',
            $this->getIssues()->getOwner(), $this->getIssues()->getRepo(), $number), Request::METHOD_POST, [
                'body' => $body
            ]);
    }

    /**
     * Edit a comment
     *
     * @link https://developer.github.com/v3/issues/comments/#edit-a-comment
     *
     * @param int    $id
     * @param string $body
     *
     * @return array
     */
    public function editComment(int $id, string $body): array
    {
        return $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/issues/comments/:id',
            $this->getIssues()->getOwner(), $this->getIssues()->getRepo(), $id), Request::METHOD_PATCH, [
                'body' => $body
            ]);
    }

    /**
     * Delete a comment
     *
     * @link https://developer.github.com/v3/issues/comments/#delete-a-comment
     *
     * @param int $id
     *
     * @return bool
     */
    public function deleteComment(int $id): bool
    {
        $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/issues/comments/:id',
            $this->getIssues()->getOwner(), $this->getIssues()->getRepo(), $id), Request::METHOD_DELETE);

        if ($this->getApi()->getHeaders()['Status'] == '204 No Content') {
            return true;
        }

        return false;
    }
}