Slick\Http\Message\Response

Complexity

Total Complexity

8

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getStatusCode()	0	3	1
A	withStatus()	0	5	1
A	getReasonPhrase()	0	3	1
A	__construct()	0	10	3
A	setStatus()	0	6	2

<?php

declare(strict_types=1);

/**
 * This file is part of slick/http
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Slick\Http\Message;

use InvalidArgumentException;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\StreamInterface;
use Slick\Http\Message\Stream\TextStream;

/**
 * Response
 *
 * @package Slick\Http\Message
*/
class Response extends Message implements ResponseInterface
{
    /**
     * @var int
     */
    private int $status;

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

    /**
     * Creates an HTTP Response message
     *
     * @param int                    $status
     * @param string|StreamInterface $body
     * @param array<string, string>  $headers
     */
    public function __construct(int $status, StreamInterface|string $body = '', array $headers = [])
    {
        $body = \is_string($body) ? new TextStream($body) : $body;
        $body->rewind();
        parent::__construct($body->getContents());

        $this->setStatus($status);

        foreach ($headers as $name => $header) {
            $this->headers[$name] = [$header];
        }
    }

    /**
     * Gets the response status code.
     *
     * The status code is a 3-digit integer result code of the server's attempt
     * to understand and satisfy the request.
     *
     * @return int Status code.
     */
    public function getStatusCode(): int
    {
        return $this->status;
    }

    /**
     * Return an instance with the specified status code and, optionally, reason phrase.
     *
     * @link http://tools.ietf.org/html/rfc7231#section-6
     * @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
     * @param int $code The 3-digit integer result code to set.
     * @param string $reasonPhrase The reason phrase to use with the
     *     provided status code; if none is provided, implementations MAY
     *     use the defaults as suggested in the HTTP specification.
     * @return static
     * @throws InvalidArgumentException For invalid status code arguments.
     */
    public function withStatus(int $code, string $reasonPhrase = ''): ResponseInterface
    {
        $response = clone $this;
        $response->setStatus($code, $reasonPhrase);
        return $response;
    }

    /**
     * Gets the response reason phrase associated with the status code.
     *
     * @link http://tools.ietf.org/html/rfc7231#section-6
     * @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
     * @return string Reason phrase; must return an empty string if none present.
     */
    public function getReasonPhrase(): string
    {
        return $this->reasonPhrase;
    }

    /**
     * Sets the response status code
     *
     * @param int $status
     * @param string $reasonPhrase
     */
    private function setStatus(int $status, string $reasonPhrase = ''): void
    {
        (new HttpCodes())->check($status);
        $this->status = $status;
        if ($reasonPhrase === '') {
            $this->reasonPhrase = (new HttpCodes())->reasonPhraseFor($this->status);
        }
    }
}