AnswerApi - Code Metrics - benatespina/StackExchangeApiClient - Measure and Improve Code Quality continuously with Scrutinizer

AnswerApi C
last analyzed 2017-09-14 16:27 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	210
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	19

Importance

Changes

Metric	Value
wmc	21
lcom	1
cbo	19
dl	0
loc	210
rs	6.875
c	0
b	0
f	0

20 Methods

Rating	Name	Size	Complexity
A	__construct()	6	1
A	acceptAnswer()	10	1
A	answers()	7	1
A	answersByIds()	7	1
A	answersOnQuestions()	7	1
A	answersOnUsers()	7	1
A	createAnswer()	10	1
A	createAnswerFlag()	10	1
A	deleteAnswer()	10	1
A	downvoteAnswer()	10	1
A	editAnswer()	10	1
A	meAnswers()	10	1
A	meTagsTopAnswers()	10	1
A	renderAnswer()	10	1
A	topUserAnswersInTags()	7	1
A	undoAcceptAnswer()	10	1
A	undoDownvoteAnswer()	10	1
A	undoUpvoteAnswer()	10	1
A	upvoteAnswer()	10	1
A	checkAuthenticationIsEnabled()	6	2

<?php

/*
 * This file is part of the Stack Exchange Api Client library.
 *
 * (c) Beñat Espiña <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace BenatEspina\StackExchangeApiClient\Api;

use BenatEspina\StackExchangeApiClient\Api\Answer\AcceptAnswer;
use BenatEspina\StackExchangeApiClient\Api\Answer\Answers;
use BenatEspina\StackExchangeApiClient\Api\Answer\AnswersByIds;
use BenatEspina\StackExchangeApiClient\Api\Answer\AnswersOnQuestions;
use BenatEspina\StackExchangeApiClient\Api\Answer\AnswersOnUsers;
use BenatEspina\StackExchangeApiClient\Api\Answer\CreateAnswer;
use BenatEspina\StackExchangeApiClient\Api\Answer\CreateAnswerFlag;
use BenatEspina\StackExchangeApiClient\Api\Answer\DeleteAnswer;
use BenatEspina\StackExchangeApiClient\Api\Answer\DownvoteAnswer;
use BenatEspina\StackExchangeApiClient\Api\Answer\EditAnswer;
use BenatEspina\StackExchangeApiClient\Api\Answer\MeAnswers;
use BenatEspina\StackExchangeApiClient\Api\Answer\MeTagsTopAnswers;
use BenatEspina\StackExchangeApiClient\Api\Answer\RenderAnswer;
use BenatEspina\StackExchangeApiClient\Api\Answer\TopUserAnswersInTags;
use BenatEspina\StackExchangeApiClient\Api\Answer\UndoAcceptAnswer;
use BenatEspina\StackExchangeApiClient\Api\Answer\UndoDownvoteAnswer;
use BenatEspina\StackExchangeApiClient\Api\Answer\UndoUpvoteAnswer;
use BenatEspina\StackExchangeApiClient\Api\Answer\UpvoteAnswer;
use BenatEspina\StackExchangeApiClient\Authentication\Authentication;
use BenatEspina\StackExchangeApiClient\Authentication\AuthenticationIsRequired;
use BenatEspina\StackExchangeApiClient\Http\HttpClient;
use BenatEspina\StackExchangeApiClient\Serializer\Serializer;

/**
 * @author Beñat Espiña <[email protected]>
 */
class AnswerApi
{
    public const QUERY_PARAMS = [
        'order'  => 'desc',
        'sort'   => 'activity',
        'site'   => 'stackoverflow',
        'filter' => HttpClient::FILTER_ALL,
    ];

    private $client;
    private $serializer;
    private $authentication;

    public function __construct(HttpClient $client, Serializer $serializer, Authentication $authentication = null)
    {
        $this->client = $client;
        $this->serializer = $serializer;
        $this->authentication = $authentication;
    }

    public function acceptAnswer(string $id, array $parameters = self::QUERY_PARAMS)

    {
        $this->checkAuthenticationIsEnabled();

        return (new AcceptAnswer(
            $this->client,
            $this->serializer,
            $this->authentication)
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        )->__invoke($id, $parameters);
    }

    public function answers(array $parameters = self::QUERY_PARAMS)

    {
        return (new Answers(
            $this->client,
            $this->serializer
        ))->__invoke($parameters);
    }

    public function answersByIds($ids, array $parameters = self::QUERY_PARAMS)

    {
        return (new AnswersByIds(
            $this->client,
            $this->serializer
        ))->__invoke($ids, $parameters);
    }

    public function answersOnQuestions($ids, array $parameters = self::QUERY_PARAMS)

    {
        return (new AnswersOnQuestions(
            $this->client,
            $this->serializer
        ))->__invoke($ids, $parameters);
    }

    public function answersOnUsers($ids, array $parameters = self::QUERY_PARAMS)

    {
        return (new AnswersOnUsers(
            $this->client,
            $this->serializer
        ))->__invoke($ids, $parameters);
    }

    public function createAnswer(string $questionId, string $body, array $parameters = self::QUERY_PARAMS)

    {
        $this->checkAuthenticationIsEnabled();

        return (new CreateAnswer(
            $this->client,
            $this->serializer,
            $this->authentication
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        ))->__invoke($questionId, $body, $parameters);
    }

    public function createAnswerFlag(string $id, array $parameters = self::QUERY_PARAMS)

    {
        $this->checkAuthenticationIsEnabled();

        return (new CreateAnswerFlag(
            $this->client,
            $this->serializer,
            $this->authentication
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        ))->__invoke($id, $parameters);
    }

    public function deleteAnswer(string $id, array $parameters = self::QUERY_PARAMS)

    {
        $this->checkAuthenticationIsEnabled();

        return (new DeleteAnswer(
            $this->client,
            $this->serializer,
            $this->authentication
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        ))->__invoke($id, $parameters);
    }

    public function downvoteAnswer(string $id, array $parameters = self::QUERY_PARAMS)

    {
        $this->checkAuthenticationIsEnabled();

        return (new DownvoteAnswer(
            $this->client,
            $this->serializer,
            $this->authentication
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        ))->__invoke($id, $parameters);
    }

    public function editAnswer(string $id, string $body, array $parameters = self::QUERY_PARAMS)

    {
        $this->checkAuthenticationIsEnabled();

        return (new EditAnswer(
            $this->client,
            $this->serializer,
            $this->authentication
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        ))->__invoke($id, $body, $parameters);
    }

    public function meAnswers(array $parameters = self::QUERY_PARAMS)

    {
        $this->checkAuthenticationIsEnabled();

        return (new MeAnswers(
            $this->client,
            $this->serializer,
            $this->authentication
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        ))->__invoke($parameters);
    }

    public function meTagsTopAnswers($tags, array $parameters = self::QUERY_PARAMS)

    {
        $this->checkAuthenticationIsEnabled();

        return (new MeTagsTopAnswers(
            $this->client,
            $this->serializer,
            $this->authentication
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        ))->__invoke($tags, $parameters);
    }

    public function renderAnswer(string $id, string $body, array $parameters = self::QUERY_PARAMS)

    {
        $this->checkAuthenticationIsEnabled();

        return (new RenderAnswer(
            $this->client,
            $this->serializer,
            $this->authentication
        ))->__invoke($id, $body, $parameters);
    }

    public function topUserAnswersInTags(string $userId, $tags, array $parameters = self::QUERY_PARAMS)

    {
        return (new TopUserAnswersInTags(
            $this->client,
            $this->serializer
        ))->__invoke($userId, $tags, $parameters);
    }

    public function undoAcceptAnswer(string $id, array $parameters = self::QUERY_PARAMS)

    {
        $this->checkAuthenticationIsEnabled();

        return (new UndoAcceptAnswer(
            $this->client,
            $this->serializer,
            $this->authentication
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        ))->__invoke($id, $parameters);
    }

    public function undoDownvoteAnswer(string $id, array $parameters = self::QUERY_PARAMS)

    {
        $this->checkAuthenticationIsEnabled();

        return (new UndoDownvoteAnswer(
            $this->client,
            $this->serializer,
            $this->authentication
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        ))->__invoke($id, $parameters);
    }

    public function undoUpvoteAnswer(string $id, array $parameters = self::QUERY_PARAMS)

    {
        $this->checkAuthenticationIsEnabled();

        return (new UndoUpvoteAnswer(
            $this->client,
            $this->serializer,
            $this->authentication
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        ))->__invoke($id, $parameters);
    }

    public function upvoteAnswer(string $id, array $parameters = self::QUERY_PARAMS)

    {
        $this->checkAuthenticationIsEnabled();

        return (new UpvoteAnswer(
            $this->client,
            $this->serializer,
            $this->authentication
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        ))->__invoke($id, $parameters);
    }

    private function checkAuthenticationIsEnabled() : void
    {
        if (!$this->authentication instanceof Authentication) {
            throw new AuthenticationIsRequired();
        }
    }
}


1			<?php
2
3			/*
4			* This file is part of the Stack Exchange Api Client library.
5			*
6			* (c) Beñat Espiña <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			declare(strict_types=1);
13
14			namespace BenatEspina\StackExchangeApiClient\Api;
15
16			use BenatEspina\StackExchangeApiClient\Api\Answer\AcceptAnswer;
17			use BenatEspina\StackExchangeApiClient\Api\Answer\Answers;
18			use BenatEspina\StackExchangeApiClient\Api\Answer\AnswersByIds;
19			use BenatEspina\StackExchangeApiClient\Api\Answer\AnswersOnQuestions;
20			use BenatEspina\StackExchangeApiClient\Api\Answer\AnswersOnUsers;
21			use BenatEspina\StackExchangeApiClient\Api\Answer\CreateAnswer;
22			use BenatEspina\StackExchangeApiClient\Api\Answer\CreateAnswerFlag;
23			use BenatEspina\StackExchangeApiClient\Api\Answer\DeleteAnswer;
24			use BenatEspina\StackExchangeApiClient\Api\Answer\DownvoteAnswer;
25			use BenatEspina\StackExchangeApiClient\Api\Answer\EditAnswer;
26			use BenatEspina\StackExchangeApiClient\Api\Answer\MeAnswers;
27			use BenatEspina\StackExchangeApiClient\Api\Answer\MeTagsTopAnswers;
28			use BenatEspina\StackExchangeApiClient\Api\Answer\RenderAnswer;
29			use BenatEspina\StackExchangeApiClient\Api\Answer\TopUserAnswersInTags;
30			use BenatEspina\StackExchangeApiClient\Api\Answer\UndoAcceptAnswer;
31			use BenatEspina\StackExchangeApiClient\Api\Answer\UndoDownvoteAnswer;
32			use BenatEspina\StackExchangeApiClient\Api\Answer\UndoUpvoteAnswer;
33			use BenatEspina\StackExchangeApiClient\Api\Answer\UpvoteAnswer;
34			use BenatEspina\StackExchangeApiClient\Authentication\Authentication;
35			use BenatEspina\StackExchangeApiClient\Authentication\AuthenticationIsRequired;
36			use BenatEspina\StackExchangeApiClient\Http\HttpClient;
37			use BenatEspina\StackExchangeApiClient\Serializer\Serializer;
38
39			/**
40			* @author Beñat Espiña <[email protected]>

benatespina / StackExchangeApiClient

AnswerApi C last analyzed 2017-09-14 16:27 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

20 Methods

Duplication Side-by-Side

Filter issues like

AnswerApi C
last analyzed 2017-09-14 16:27 UTC