Igni\Network\Http\Response

Complexity

Total Complexity

21

Size/Duplication

Total Lines	321
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	4

Test Coverage

Coverage

90.74%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	write()	0	9	2
A	end()	0	10	2
A	isComplete()	0	4	1
A	getStatusCode()	0	4	1
A	getReasonPhrase()	0	8	3
A	withStatus()	0	7	1
A	asJson()	0	11	3
A	asText()	0	5	1
A	asHtml()	0	5	1
A	asXml()	0	15	4
A	empty()	0	5	1

<?php declare(strict_types=1);

namespace Igni\Network\Http;

use DOMDocument;
use Igni\Exception\RuntimeException;
use Igni\Network\Exception\InvalidArgumentException;
use JsonSerializable;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\StreamInterface;
use SimpleXMLElement;
use Zend\Diactoros\MessageTrait;

use function is_array;
use function is_string;
use function json_encode;

/**
 * PSR-7 implementation of ResponseInterface.
 * Utilizes zend/diactoros implementation.
 *
 * @see ResponseInterface
 * @package Igni\Http
 */
class Response implements ResponseInterface
{
    use MessageTrait;

    const HTTP_CONTINUE = 100;
    const HTTP_SWITCHING_PROTOCOLS = 101;
    const HTTP_PROCESSING = 102;
    const HTTP_OK = 200;
    const HTTP_CREATED = 201;
    const HTTP_ACCEPTED = 202;
    const HTTP_NON_AUTHORITATIVE_INFORMATION = 203;
    const HTTP_NO_CONTENT = 204;
    const HTTP_RESET_CONTENT = 205;
    const HTTP_PARTIAL_CONTENT = 206;
    const HTTP_MULTI_STATUS = 207;
    const HTTP_ALREADY_REPORTED = 208;
    const HTTP_IM_USED = 226;
    const HTTP_MULTIPLE_CHOICES = 300;
    const HTTP_MOVED_PERMANENTLY = 301;
    const HTTP_FOUND = 302;
    const HTTP_SEE_OTHER = 303;
    const HTTP_NOT_MODIFIED = 304;
    const HTTP_USE_PROXY = 305;
    const HTTP_RESERVED = 306;
    const HTTP_TEMPORARY_REDIRECT = 307;
    const HTTP_PERMANENTLY_REDIRECT = 308;
    const HTTP_BAD_REQUEST = 400;
    const HTTP_UNAUTHORIZED = 401;
    const HTTP_PAYMENT_REQUIRED = 402;
    const HTTP_FORBIDDEN = 403;
    const HTTP_NOT_FOUND = 404;
    const HTTP_METHOD_NOT_ALLOWED = 405;
    const HTTP_NOT_ACCEPTABLE = 406;
    const HTTP_PROXY_AUTHENTICATION_REQUIRED = 407;
    const HTTP_REQUEST_TIMEOUT = 408;
    const HTTP_CONFLICT = 409;
    const HTTP_GONE = 410;
    const HTTP_LENGTH_REQUIRED = 411;
    const HTTP_PRECONDITION_FAILED = 412;
    const HTTP_REQUEST_ENTITY_TOO_LARGE = 413;
    const HTTP_REQUEST_URI_TOO_LONG = 414;
    const HTTP_UNSUPPORTED_MEDIA_TYPE = 415;
    const HTTP_REQUESTED_RANGE_NOT_SATISFIABLE = 416;
    const HTTP_EXPECTATION_FAILED = 417;
    const HTTP_I_AM_A_TEAPOT = 418;
    const HTTP_MISDIRECTED_REQUEST = 421;
    const HTTP_UNPROCESSABLE_ENTITY = 422;
    const HTTP_LOCKED = 423;
    const HTTP_FAILED_DEPENDENCY = 424;
    const HTTP_RESERVED_FOR_WEBDAV_ADVANCED_COLLECTIONS_EXPIRED_PROPOSAL = 425;
    const HTTP_UPGRADE_REQUIRED = 426;
    const HTTP_PRECONDITION_REQUIRED = 428;
    const HTTP_TOO_MANY_REQUESTS = 429;
    const HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE = 431;
    const HTTP_UNAVAILABLE_FOR_LEGAL_REASONS = 451;
    const HTTP_INTERNAL_SERVER_ERROR = 500;
    const HTTP_NOT_IMPLEMENTED = 501;
    const HTTP_BAD_GATEWAY = 502;
    const HTTP_SERVICE_UNAVAILABLE = 503;
    const HTTP_GATEWAY_TIMEOUT = 504;
    const HTTP_VERSION_NOT_SUPPORTED = 505;
    const HTTP_VARIANT_ALSO_NEGOTIATES_EXPERIMENTAL = 506;
    const HTTP_INSUFFICIENT_STORAGE = 507;
    const HTTP_LOOP_DETECTED = 508;
    const HTTP_NOT_EXTENDED = 510;
    const HTTP_NETWORK_AUTHENTICATION_REQUIRED = 511;

    /**
     * Map of standard HTTP status code/reason phrases
     *
     * @var array
     */
    private static $phrases = [
        // INFORMATIONAL CODES
        100 => 'Continue',
        101 => 'Switching Protocols',
        102 => 'Processing',
        // SUCCESS CODES
        200 => 'OK',
        201 => 'Created',
        202 => 'Accepted',
        203 => 'Non-Authoritative Information',
        204 => 'No Content',
        205 => 'Reset Content',
        206 => 'Partial Content',
        207 => 'Multi-status',
        208 => 'Already Reported',
        // REDIRECTION CODES
        300 => 'Multiple Choices',
        301 => 'Moved Permanently',
        302 => 'Found',
        303 => 'See Other',
        304 => 'Not Modified',
        305 => 'Use Proxy',
        306 => 'Switch Proxy', // Deprecated
        307 => 'Temporary Redirect',
        // CLIENT ERROR
        400 => 'Bad Request',
        401 => 'Unauthorized',
        402 => 'Payment Required',
        403 => 'Forbidden',
        404 => 'Not Found',
        405 => 'Method Not Allowed',
        406 => 'Not Acceptable',
        407 => 'Proxy Authentication Required',
        408 => 'Request Time-out',
        409 => 'Conflict',
        410 => 'Gone',
        411 => 'Length Required',
        412 => 'Precondition Failed',
        413 => 'Request Entity Too Large',
        414 => 'Request-URI Too Large',
        415 => 'Unsupported Media Property',
        416 => 'Requested range not satisfiable',
        417 => 'Expectation Failed',
        418 => 'I\'m a teapot',
        422 => 'Unprocessable Entity',
        423 => 'Locked',
        424 => 'Failed Dependency',
        425 => 'Unordered Collection',
        426 => 'Upgrade Required',
        428 => 'Precondition Required',
        429 => 'Too Many Requests',
        431 => 'Request Header Fields Too Large',
        // SERVER ERROR
        500 => 'Internal Server Error',
        501 => 'Not Implemented',
        502 => 'Bad Gateway',
        503 => 'Service Unavailable',
        504 => 'Gateway Time-out',
        505 => 'HTTP Version not supported',
        506 => 'Variant Also Negotiates',
        507 => 'Insufficient Storage',
        508 => 'Loop Detected',
        511 => 'Network Authentication Required',
    ];

    /**
     * @var string
     */
    private $reasonPhrase = '';

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

    /**
     * @var bool
     */
    private $complete = false;

    /**
     * @param string|resource|StreamInterface $body Stream identifier and/or actual stream resource
     * @param int $status Status code for the response, if any.
     * @param array $headers Headers for the response, if any.
     * @throws \InvalidArgumentException on any invalid element.
     */
    public function __construct($body = '', int $status = self::HTTP_OK, array $headers = [])
    {
        $this->stream = Stream::create($body, 'wb+');

It seems like \Igni\Network\Http\Stream::create($body, 'wb+') of type object<self> is incompatible with the declared type object<Psr\Http\Message\StreamInterface> of property $stream.

        $this->statusCode = $status;
        $this->reasonPhrase = self::$phrases[$this->statusCode];
        $this->setHeaders($headers);
    }

    /**
     * Writes content to the response body
     *
     * @param string $body
     * @return $this
     */
    public function write(string $body)
    {
        if ($this->complete) {
            throw new RuntimeException('Cannot write to the response, response is already completed.');
        }

        $this->getBody()->write($body);
        return $this;
    }

    /**
     * Ends and closes response.
     *
     * @return $this
     */
    public function end()
    {
        if ($this->complete) {
            return $this;
        }

        $this->complete = true;

        return $this;
    }

    public function isComplete(): bool
    {
        return $this->complete;
    }

    /**
     * {@inheritdoc}
     */
    public function getStatusCode()
    {
        return $this->statusCode;
    }

    /**
     * {@inheritdoc}
     */
    public function getReasonPhrase()
    {
        if (!$this->reasonPhrase && isset(self::$phrases[$this->statusCode])) {
            $this->reasonPhrase = self::$phrases[$this->statusCode];
        }

        return $this->reasonPhrase;
    }

    /**
     * {@inheritdoc}
     */
    public function withStatus($code, $reasonPhrase = '')
    {
        $new = clone $this;
        $new->statusCode = $code;
        $new->reasonPhrase = $reasonPhrase;
        return $new;
    }

    /**
     * Factories response instance from json data.
     *
     * @param array|\JsonSerializable $data
     * @param int $status
     * @param array $headers
     * @return Response
     * @throws InvalidArgumentException
     */
    public static function asJson($data, int $status = self::HTTP_OK, array $headers = [])
    {
        if (! $data instanceof JsonSerializable && !is_array($data)) {

The class JsonSerializable does not exist. Is this class maybe located in a folder that is not analyzed, or in a newer version of your dependencies than listed in your composer.lock/composer.json?

            throw new InvalidArgumentException('Invalid $data provided, method expects array or instance of \JsonSerializable.');
        }

        $headers['Content-Type'] = 'application/json';

        $body = json_encode($data, JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_QUOT | JSON_UNESCAPED_SLASHES);
        return new Response($body, $status, $headers);
    }

    /**
     * Factories response instance from text.
     *
     * @param string $text
     * @param int $status
     * @param array $headers
     * @return Response
     */
    public static function asText(string $text, int $status = self::HTTP_OK, array $headers = []): Response
    {
        $headers['Content-Type'] = 'text/plain';
        return new Response($text, $status, $headers);
    }

    /**
     * Factories response from html text.
     *
     * @param string $html
     * @param int $status
     * @param array $headers
     * @return Response
     */
    public static function asHtml(string $html, int $status = self::HTTP_OK, array $headers = [])
    {
        $headers['Content-Type'] = 'text/html';
        return new Response($html, $status, $headers);
    }

    /**
     * Factories xml response.
     *
     * @param SimpleXMLElement|DOMDocument|string $data
     * @param int $status
     * @param array $headers
     * @return Response
     * @throws InvalidArgumentException
     */
    public static function asXml($data, int $status = self::HTTP_OK, array $headers = [])
    {
        if ($data instanceof SimpleXMLElement) {
            $body = $data->asXML();
        } elseif ($data instanceof DOMDocument) {
            $body = $data->saveXML();
        } elseif (is_string($data)) {
            $body = $data;
        } else {
            throw new InvalidArgumentException('Invalid $data provided, method expects valid string or instance of \SimpleXMLElement, \DOMDocument');
        }

        $headers['Content-Type'] = 'text/xml';
        return new Response($body, $status, $headers);

It seems like $body defined by $data->asXML() on line 320 can also be of type false; however, Igni\Network\Http\Response::__construct() does only seem to accept string|resource|object<Psr\Http\Message\StreamInterface>, did you maybe forget to handle an error condition?

    }

    /**
     * Factories empty response.
     *
     * @param int $status
     * @param array $headers
     * @return Response
     */
    public static function empty(int $status = self::HTTP_OK, array $headers = [])
    {
        $headers['Content-Type'] = 'text/plain';
        return new Response('', $status, $headers);
    }
}