Response.php

<?php

/**
 * DframeFramework
 * Copyright (c) Sławomir Kaleta.
 *
 * @license https://github.com/dframe/dframe/blob/master/LICENCE (MIT)
 */

namespace Dframe\Router;

/**
 * Short Description.
 *
 * @author Sławomir Kaleta <slaszka@gmail.com>
 */
class Response extends Router
{
    /**
     * @var array
     */
    public static array $code = [
        100 => 'Continue',
        101 => 'Switching Protocols',
        102 => 'Processing',
        200 => 'OK',
        201 => 'Created',
        202 => 'Accepted',
        203 => 'Non-Authoritative Information',
        204 => 'No Content',
        205 => 'Reset Content',
        206 => 'Partial Content',
        207 => 'Multi-Status',
        300 => 'Multiple Choices',
        301 => 'Moved Permanently',
        302 => 'Found',
        303 => 'See Other',
        304 => 'Not Modified',
        305 => 'Use Proxy',
        306 => 'Switch Proxy',
        307 => 'Temporary Redirect',
        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 => 'Request Entity Too Large',
        414 => 'Request-URI Too Long',
        415 => 'Unsupported Media Type',
        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',
        449 => 'Retry With',
        450 => 'Blocked by Windows Parental Controls',
        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',
        509 => 'Bandwidth Limit Exceeded',
        510 => 'Not Extended',
    ];

    /**
     * @var int
     */
    public int $status = 200;

    /**
     * @var null|string
     */
    protected ?string $body = null;

    /**
     * @var array
     */
    protected array $headers = [];

    /**
     * Response constructor.
     *
     * @param mixed $body
     */
    public function __construct($body = null)
    {
        if (isset($body)) {
            $this->body = $body;
        }

        return $this;
    }

    /**
     * @param mixed $body
     *
     * @return Response
     */
    public static function create($body = null): self
    {
        return new self($body);
    }

    /**
     * @param mixed $body
     *
     * @return Response
     */
    public static function render($body = null): self
    {
        return new self($body);
    }

    /**
     * @param mixed    $body
     * @param null|int $status
     *
     * @return Response
     */
    public static function renderJSON($body = null, $status = null): self
    {
        $body = json_encode($body);
        $Response = new self($body);

        if (isset($status)) {
            $Response->status($status);
        }

        $Response->headers(['Content-Type' => 'application/json']);

        return $Response;
    }

    /**
     * @param $code
     *
     * @return self
     */
    public function status($code): self
    {
        $this->status = $code;

        return $this;
    }

    /**
     * @param array $headers
     *
     * @return self
     */
    public function headers($headers = []): self
    {
        if (!empty($headers)) {
            $this->headers = array_unique(array_merge($this->headers, $headers));
        }

        return $this;
    }

    /**
     * @param mixed    $body
     * @param null|int $status
     *
     * @return Response
     */
    public static function renderJSONP($body = null, $status = null): Response
    {
        $callback = null;
        if (isset($_GET['callback'])) {
            $callback = $_GET['callback'];
        }

        $Response = new self($callback . '(' . json_encode($body) . ')');

        if (isset($status)) {
            $Response->status($status);
        }

        $Response->headers(['Content-Type' => 'application/jsonp']);

        return $Response;
    }

    /**
     * Address redirection.
     *
     * @param string $url
     * @param int    $status
     * @param array  $headers
     *
     * @return Response
     */
    public static function redirect($url = '', $status = 301, $headers = []): Response
    {
        $Response = new Response();
        $Response->status($status);

        if (!empty($headers)) {
            $Response->headers($headers);
        }

        $Response->headers(
            [
                'Location' => ((new Router())->boot())->makeUrl($url),
            ]
        );

        return $Response;
    }

    /**
     * @param $json
     *
     * @return self
     */
    public function json($json): self
    {
        $this->headers(['Content-Type' => 'application/json']);
        $this->body = json_encode($json);

        return $this;
    }

    /**
     * @return int
     */
    public function getStatus(): int
    {
        return $this->status;
    }

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

    /**
     * @param mixed $body
     *
     * @return self
     */
    public function body($body = null): self
    {
        $this->body = $body;

        return $this;
    }

    /**
     * Display string and return int
     *
     * @return null|string
     */
    public function display(): ?string
    {
        if (!headers_sent()) {
            if (PHP_SAPI !== 'cli') {
                $protocol = (isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.1');
                $status = (!empty($this->status) ? $this->status : 200);
                $string = sprintf('%s %d %s', $protocol, $status, self::$code[$status]);

                header($string, true, $status); // Default header
                if (!empty($this->headers)) {
                    foreach ($this->headers as $field => $value) {
                        if (is_array($value)) {
                            foreach ($value as $v) {
                                header("$field" . ': ' . $v, false);
                            }
                        } else {
                            header("$field" . ': ' . $value);
                        }
                    }
                }
            }
        }

        return print $this->getBody() ? $this->getBody() : null;
    }

    /**
     * @return null|string
     */
    public function getBody(): ?string
    {
        return $this->body;
    }

    /**
     * @return null|string
     */
    public function __toString(): string
    {
        return $this->body ?? "";
    }
}