Pivasic\Core\Response

Complexity

Total Complexity

26

Size/Duplication

Total Lines	208
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	is404()	0	4	1
B	send()	0	18	10
A	setContent()	0	5	1
A	header()	0	8	4
A	setContentTypeJson()	0	4	1
A	setContentTypeXml()	0	4	1
B	setStatusCode()	0	76	3
A	redirect()	0	28	4

<?php
/**
 * @license MIT
 */
namespace Pivasic\Core;

/**
 * Represents a HTTP response.
 *
 * Class Response
 * @package Pivasic\Core
 */
class Response
{
    /**
     * Response constructor.
     */
    public function __construct()
    {
        $this->content = '';
        $this->is404 = true;
    }

    /**
     * False if response body was set.
     * @return bool
     */
    public function is404(): bool
    {
        return $this->is404;
    }

    /**
     * Send response.
     */
    public function send()
    {
        echo $this->content;

        if (function_exists('fastcgi_finish_request')) {
            fastcgi_finish_request();
        } elseif ('cli' !== php_sapi_name()) {
            $level = ob_get_level();
            if (0 < $level) {
                $status = ob_get_status(true);
                // PHP_OUTPUT_HANDLER_* are not defined on HHVM 3.3
                $flags = defined('PHP_OUTPUT_HANDLER_REMOVABLE') ? PHP_OUTPUT_HANDLER_REMOVABLE | PHP_OUTPUT_HANDLER_FLUSHABLE : -1;
                while ($level-- > 0 && ($s = $status[$level]) && (!isset($s['del']) ? !isset($s['flags']) || $flags === ($s['flags'] & $flags) : $s['del'])) {
                    ob_end_flush();
                }
            }
        }
    }

    /**
     * Set response body.
     *
     * @param string $content
     */
    public function setContent(string $content)
    {
        $this->is404 = false;
        $this->content = $content;
    }

    /**
     * Set response header.
     *
     * @param string $name
     * @param string $value
     * @return bool
     */
    public function header(string $name, string $value): bool
    {
        if (!empty($name) && !empty($value) && !headers_sent()) {
            header($name . ': ' . $value);
            return true;
        }
        return false;
    }

    /**
     * @return bool
     */
    public function setContentTypeJson(): bool
    {
        return $this->header('Content-Type', 'application/json; charset=utf-8');
    }

    /**
     * @return bool
     */
    public function setContentTypeXml(): bool
    {
        return $this->header('Content-Type', 'text/xml; charset=utf-8');
    }

    /**
     * Set response status.
     *
     * @param int $statusCode           - status
     * @param string $version           - HTTP version
     * @param string $statusText   - status text
     * @return bool
     */
    public function setStatusCode(int $statusCode, string $version = '1.1', string $statusText = ''): bool
    {
        if (!headers_sent()) {
            $statusCode = intval($statusCode);

            if ('' == $statusText) {
                $statusTexts = [
                    100 => 'Continue',
                    101 => 'Switching Protocols',
                    102 => 'Processing',            // RFC2518
                    200 => 'OK',
                    201 => 'Created',
                    202 => 'Accepted',
                    203 => 'Non-Authoritative Information',
                    204 => 'No Content',
                    205 => 'Reset Content',
                    206 => 'Partial Content',
                    207 => 'Multi-Status',          // RFC4918
                    208 => 'Already Reported',      // RFC5842
                    226 => 'IM Used',               // RFC3229
                    300 => 'Multiple Choices',
                    301 => 'Moved Permanently',
                    302 => 'Found',
                    303 => 'See Other',
                    304 => 'Not Modified',
                    305 => 'Use Proxy',
                    307 => 'Temporary Redirect',
                    308 => 'Permanent Redirect',    // RFC7238
                    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',
                    418 => 'I\'m a teapot',                                               // RFC2324
                    422 => 'Unprocessable Entity',                                        // RFC4918
                    423 => 'Locked',                                                      // RFC4918
                    424 => 'Failed Dependency',                                           // RFC4918
                    425 => 'Reserved for WebDAV advanced collections expired proposal',   // RFC2817
                    426 => 'Upgrade Required',                                            // RFC2817
                    428 => 'Precondition Required',                                       // RFC6585
                    429 => 'Too Many Requests',                                           // RFC6585
                    431 => 'Request Header Fields Too Large',                             // RFC6585
                    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 (Experimental)',                      // RFC2295
                    507 => 'Insufficient Storage',                                        // RFC4918
                    508 => 'Loop Detected',                                               // RFC5842
                    510 => 'Not Extended',                                                // RFC2774
                    511 => 'Network Authentication Required',                             // RFC6585
                ];
                $statusText = $statusTexts[$statusCode];
            }

            header(sprintf('HTTP/%s %s %s', $version, $statusCode, $statusText), true, $statusCode);
            return true;
        }

        return false;
    }

    /**
     * Redirect to url with statusCode and terminate.
     *
     * @param string $url
     * @param int $statusCode
     */
    public function redirect(string $url = '', int $statusCode = 302)
    {
        $this->is404 = false;
        $server = filter_input_array(INPUT_SERVER);
        if ('' == $url && isset($server['REQUEST_URI'])) {
            $url = '/' . trim($server['REQUEST_URI'], '/');
            preg_match('/^[\\a-zA-Z0-9-\._~:\/\?\#\[\]\@\!\$\&\'\(\)\*\+\,\;\=%]*$/iD', $url, $match);
            $url = $match[1] ?? '';
        }

        if (!headers_sent()) {
            header('Location: ' . $url, true, $statusCode);
        }

        echo sprintf('<!DOCTYPE html>
<html>
    <head>
        <meta charset="UTF-8" />
        <meta http-equiv="refresh" content="0;url=%1$s" />
        <title>Redirecting to %1$s</title>
    </head>
    <body>
        <script type="text/javascript"> window.location.href = "%1$s"; </script>
        Redirecting to <a href="%1$s">%1$s</a>.
    </body>
</html>', htmlspecialchars($url, ENT_QUOTES, 'UTF-8'));

    }

    private $content;
    private $is404;
}