Sunrise\Http\Message\Response

Complexity

Total Complexity

17

Size/Duplication

Total Lines	194
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	validateStatusCode()	0	8	4
A	validateReasonPhrase()	0	12	4
A	setStatus()	0	11	2
A	getStatusCode()	0	3	1
A	__construct()	0	16	4
A	getReasonPhrase()	0	3	1
A	withStatus()	0	6	1

<?php declare(strict_types=1);

/**
 * It's free open-source software released under the MIT License.
 *
 * @author Anatoly Nekhay <afenric@gmail.com>
 * @copyright Copyright (c) 2018, Anatoly Nekhay
 * @license https://github.com/sunrise-php/http-message/blob/master/LICENSE
 * @link https://github.com/sunrise-php/http-message
 */

namespace Sunrise\Http\Message;

use Fig\Http\Message\StatusCodeInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\StreamInterface;
use Sunrise\Http\Message\Exception\InvalidArgumentException;

use function is_int;
use function is_string;
use function preg_match;

class Response extends Message implements ResponseInterface, StatusCodeInterface
{
    /**
     * List of Reason Phrases
     *
     * @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
     *
     * @var array<int<100, 599>, non-empty-string>
     */
    public const REASON_PHRASES = [
        // 1xx
        100 => 'Continue',
        101 => 'Switching Protocols',
        102 => 'Processing',
        103 => 'Early Hints',
        // 2xx
        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',
        226 => 'IM Used',
        // 3xx
        300 => 'Multiple Choices',
        301 => 'Moved Permanently',
        302 => 'Found',
        303 => 'See Other',
        304 => 'Not Modified',
        305 => 'Use Proxy',
        307 => 'Temporary Redirect',
        308 => 'Permanent Redirect',
        // 4xx
        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 Timeout',
        409 => 'Conflict',
        410 => 'Gone',
        411 => 'Length Required',
        412 => 'Precondition Failed',
        413 => 'Payload Too Large',
        414 => 'URI Too Long',
        415 => 'Unsupported Media Type',
        416 => 'Range Not Satisfiable',
        417 => 'Expectation Failed',
        421 => 'Misdirected Request',
        422 => 'Unprocessable Entity',
        423 => 'Locked',
        424 => 'Failed Dependency',
        425 => 'Too Early',
        426 => 'Upgrade Required',
        428 => 'Precondition Required',
        429 => 'Too Many Requests',
        431 => 'Request Header Fields Too Large',
        451 => 'Unavailable For Legal Reasons',
        // 5xx
        500 => 'Internal Server Error',
        501 => 'Not Implemented',
        502 => 'Bad Gateway',
        503 => 'Service Unavailable',
        504 => 'Gateway Timeout',
        505 => 'HTTP Version Not Supported',
        506 => 'Variant Also Negotiates',
        507 => 'Insufficient Storage',
        508 => 'Loop Detected',
        510 => 'Not Extended',
        511 => 'Network Authentication Required',
    ];

    private int $statusCode = self::STATUS_OK;
    private string $reasonPhrase = self::REASON_PHRASES[self::STATUS_OK];

    /**
     * @param array<string, string|string[]>|null $headers
     *
     * @throws InvalidArgumentException
     */
    public function __construct(
        ?int $statusCode = null,
        ?string $reasonPhrase = null,
        ?array $headers = null,
        ?StreamInterface $body = null
    ) {
        if ($statusCode !== null) {
            $this->setStatus($statusCode, $reasonPhrase ?? '');
        }

        if ($headers !== null) {
            $this->setHeaders($headers);
        }

        if ($body !== null) {
            $this->setBody($body);
        }
    }

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

    /**
     * @inheritDoc
     */
    public function getReasonPhrase(): string
    {
        return $this->reasonPhrase;
    }

    /**
     * @inheritDoc
     */
    public function withStatus($code, $reasonPhrase = ''): ResponseInterface
    {
        $clone = clone $this;
        $clone->setStatus($code, $reasonPhrase);

        return $clone;
    }

    /**
     * Sets the given status code to the response
     *
     * @param int $statusCode
     * @param string $reasonPhrase
     *
     * @throws InvalidArgumentException
     */
    final protected function setStatus($statusCode, $reasonPhrase): void
    {
        $this->validateStatusCode($statusCode);
        $this->validateReasonPhrase($reasonPhrase);

        if ($reasonPhrase === '') {
            $reasonPhrase = self::REASON_PHRASES[$statusCode] ?? 'Unknown Status Code';
        }

        $this->statusCode = $statusCode;
        $this->reasonPhrase = $reasonPhrase;
    }

    /**
     * Validates the given status code
     *
     * @link https://tools.ietf.org/html/rfc7230#section-3.1.2
     *
     * @param mixed $statusCode
     *
     * @throws InvalidArgumentException
     */
    private function validateStatusCode($statusCode): void
    {
        if (!is_int($statusCode)) {
            throw new InvalidArgumentException('HTTP status code must be an integer');
        }

        if (!($statusCode >= 100 && $statusCode <= 599)) {
            throw new InvalidArgumentException('Invalid HTTP status code');
        }
    }

    /**
     * Validates the given reason phrase
     *
     * @link https://tools.ietf.org/html/rfc7230#section-3.1.2
     *
     * @param mixed $reasonPhrase
     *
     * @throws InvalidArgumentException
     */
    private function validateReasonPhrase($reasonPhrase): void
    {
        if ($reasonPhrase === '') {
            return;
        }

        if (!is_string($reasonPhrase)) {
            throw new InvalidArgumentException('HTTP reason phrase must be a string');
        }

        if (!preg_match(HeaderInterface::RFC7230_FIELD_VALUE_REGEX, $reasonPhrase)) {
            throw new InvalidArgumentException('Invalid HTTP reason phrase');
        }
    }
}