Commercetools\Core\Response\AbstractApiResponse

Complexity

Total Complexity

22

Size/Duplication

Total Lines	187
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	1	Features	2

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	toObject()	0	8	2
A	toArray()	0	7	2
A	getBody()	0	7	2
A	isError()	0	6	1
A	getResponseField()	0	5	2
A	getErrors()	0	7	2
A	getCorrelationId()	0	4	1
A	getStatusCode()	0	4	1
A	getHeader()	0	4	1
A	getHeaders()	0	4	1
A	getResponse()	0	4	1
A	getRequest()	0	4	1
A	wait()	0	8	2
A	then()	0	9	2

<?php
/**
 * @author @jayS-de <jens.schulze@commercetools.de>
 * @created: 26.01.15, 14:44
 */

namespace Commercetools\Core\Response;

use Commercetools\Core\Error\ErrorContainer;
use Psr\Http\Message\ResponseInterface;
use Commercetools\Core\Client\Adapter\AdapterPromiseInterface;
use Commercetools\Core\Error\Message;
use Commercetools\Core\Model\Common\Context;
use Commercetools\Core\Model\Common\ContextAwareInterface;
use Commercetools\Core\Model\Common\ContextTrait;
use Commercetools\Core\Request\ClientRequestInterface;

/**
 * @package Commercetools\Core\Response
 */
abstract class AbstractApiResponse implements ApiResponseInterface, ContextAwareInterface
{
    const X_CORRELATION_ID = 'X-Correlation-ID';
    use ContextTrait;

    /**
     * @var ResponseInterface|AdapterPromiseInterface
     */
    protected $response;

    /**
     * @var ClientRequestInterface
     */
    protected $request;

    /**
     * @var array
     */
    protected $jsonData;

    /**
     * @var string
     */
    protected $responseBody;

    /**
     * @var ErrorContainer
     */
    private $errors;

    /**
     * @param ResponseInterface $response
     * @param ClientRequestInterface $request
     * @param Context $context
     */
    public function __construct(ResponseInterface $response, ClientRequestInterface $request, Context $context = null)
    {
        $this->setContext($context);
        $this->response = $response;
        $this->request = $request;
    }

    /**
     * @return mixed|null
     */
    public function toObject()
    {
        if (!$this->isError()) {
            return $this->getRequest()->mapResponse($this);
        }

        return null;
    }

    /**
     * @return array
     */
    public function toArray()
    {
        if (is_null($this->jsonData)) {
            $this->jsonData = json_decode($this->getBody(), true);

It seems like json_decode($this->getBody(), true) of type * is incompatible with the declared type array of property $jsonData.

        }
        return $this->jsonData;
    }

    /**
     * @return string
     */
    public function getBody()
    {
        if (is_null($this->responseBody)) {
            $this->responseBody = (string)$this->response->getBody();
        }
        return $this->responseBody;
    }

    /**
     * @return bool
     */
    public function isError()
    {
        $statusCode = $this->getStatusCode();

        return (!in_array($statusCode, [200, 201]));
    }

    protected function getResponseField($fieldName, $default = '')
    {
        $result = $this->toArray();
        return isset($result[$fieldName]) ? $result[$fieldName]: $default;
    }

    /**
     * @return array
     */
    public function getErrors()
    {
        if (is_null($this->errors)) {
            $this->errors = ErrorContainer::fromArray($this->getResponseField('errors', []), $this->getContext());

array() is of type array, but the function expects a string.

        }
        return $this->errors;
    }

    public function getCorrelationId()
    {
        return current($this->getHeader(self::X_CORRELATION_ID));

The expression current($this->getHeader(self::X_CORRELATION_ID)); of type string|false adds false to the return on line 126 which is incompatible with the return type declared by the interface Commercetools\Core\Response\ApiResponseInterface::getCorrelationId of type string. It seems like you forgot to handle an error condition.

    }

    public function getStatusCode()
    {
        return $this->getResponse()->getStatusCode();
    }

    /**
     * @param string $header
     * @return array
     */
    /**
     * @param string $header
     * @return string[]
     */
    public function getHeader($header)
    {
        return $this->getResponse()->getHeader($header);
    }

    /**
     * @return array
     */
    public function getHeaders()
    {
        return $this->getResponse()->getHeaders();
    }

    /**
     * @return ResponseInterface|AdapterPromiseInterface
     */
    public function getResponse()
    {
        return $this->response;
    }

    /**
     * @return ClientRequestInterface
     */
    public function getRequest()
    {
        return $this->request;
    }

    /**
     * Returns the result of the future either from cache or by blocking until
     * it is complete.
     *
     * This method must block until the future has a result or is cancelled.
     * Throwing an exception in the wait() method will mark the future as
     * realized and will throw the exception each time wait() is called.
     * Throwing an instance of GuzzleHttp\Ring\CancelledException will mark
     * the future as realized, will not throw immediately, but will throw the
     * exception if the future's wait() method is called again.
     *
     * @return mixed
     */
    public function wait()
    {
        if (!$this->getResponse() instanceof AdapterPromiseInterface) {
            throw new \BadMethodCallException(Message::FUTURE_BAD_METHOD_CALL);
        }

        return $this->getResponse()->wait();
    }

    /**
     * @param callable $onFulfilled
     * @param callable $onRejected
     * @return ApiResponseInterface
     */
    public function then(callable $onFulfilled = null, callable $onRejected = null)
    {
        if (!$this->getResponse() instanceof AdapterPromiseInterface) {
            throw new \BadMethodCallException(Message::FUTURE_BAD_METHOD_CALL);
        }
        $this->getResponse()->then($onFulfilled, $onRejected);

        return $this;
    }
}