hiqdev / yii2-hiart

src/AbstractResponse.php

<?php
/**
 * ActiveRecord for API
 *
 * @link      https://github.com/hiqdev/yii2-hiart
 * @package   yii2-hiart
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2019, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\hiart;

use yii\helpers\Json;

abstract class AbstractResponse implements ResponseInterface
{
    /**
     * @var RequestInterface
     */
    protected $request;

    /**
     * @var string response data. The property contains RAW response data
     * @see decodeData()
     * @see isDecoded
     */
    protected $data;

    /**
     * @var bool whether response is already decoded
     */
    protected $isDecoded = false;

    public function getRequest()
    {
        return $this->request;
    }

    public function getData()
    {
        if (!$this->isDecoded) {
            $this->data = $this->decodeData();

It seems like $this->decodeData() can also be of type array. However, the property $data is declared as type string. Maybe add an additional type check?

            $this->isDecoded = true;
        }

        return $this->data;
    }

    public function decodeData()
    {
        $data = $this->getRawData();

        if ($this->isRaw()) {
            return $data;
        }

        if ($this->isJson()) {
            return $this->decodeJson($data);
        }

        // TODO: implement decoding for XML and other types

        // throw new ResponseDecodingException('Failed to detect response data type', $this);
        // TODO: throw exception instead of returning
        return $data;
    }

    /**
     * Method returns RAW request data.
     *
     * @return string
     */
    abstract public function getRawData();

    /**
     * Whether the request is RAW and should not be decoded.
     * @return bool
     */
    public function isRaw()
    {
        return $this->request->isRaw();

The method isRaw() does not exist on hiqdev\hiart\RequestInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to hiqdev\hiart\RequestInterface.

    }

    /**
     * Method checks whether response is a JSON response.
     * @return bool
     */
    public function isJson()
    {
        $value = $this->getHeader('Content-Type');
        if ($value === null) {

The condition $value === null is always false.

            return false;
        }

        return !empty(preg_grep('|application/json|i', $value));
    }

    /**
     * @param $name
     * @return array
     */
    abstract public function getHeader($name);

    /**
     * @param string $data JSON data
     * @return array
     */
    protected function decodeJson($data)
    {
        return Json::decode($data);
    }
}