9.5/extbase_2_classes_2_mvc_2_web_2_response_8php_source.html

<?php

namespace ‪TYPO3\CMS\Extbase\Mvc\Web;


/*

 * This file is part of the TYPO3 CMS project.

 *

 * It is free software; you can redistribute it and/or modify it under

 * the terms of the GNU General Public License, either version 2

 * of the License, or any later version.

 *

 * For the full copyright and license information, please read the

 * LICENSE.txt file that was distributed with this source code.

 *

 * The TYPO3 project - inspiring people to share!

 */


use ‪TYPO3\CMS\Core\Page\PageRenderer;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;

use ‪TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;


class ‪Response extends ‪\TYPO3\CMS\Extbase\Mvc\Response

{

    protected ‪$headers = [];


    protected ‪$additionalHeaderData = [];


    protected ‪$statusCode;


    protected ‪$statusMessage = 'OK';


    protected ‪$request;


    protected ‪$statusMessages = [

        // INFORMATIONAL CODES

        100 => 'Continue',

        101 => 'Switching Protocols',

        102 => 'Processing',

        103 => 'Early Hints',

        // 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',

        226 => 'IM Used',

        // 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',

        308 => 'Permanent 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 Timeout',

        409 => 'Conflict',

        410 => 'Gone',

        411 => 'Length Required',

        412 => 'Precondition Failed',

        413 => 'Request Entity Too Large',

        414 => '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',

        428 => 'Precondition Required',

        429 => 'Too Many Requests',

        431 => 'Request Header Fields Too Large',

        451 => 'Unavailable For Legal Reasons',

        // 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',

        509 => 'Bandwidth Limit Exceeded',

        511 => 'Network Authentication Required',

    ];


    protected ‪$environmentService;


    public function ‪injectEnvironmentService(\‪TYPO3\CMS\‪Extbase\Service\EnvironmentService ‪$environmentService)

    {

        $this->environmentService = ‪$environmentService;

    }


    public function ‪setStatus($code, $message = null)

    {

        if (!is_int($code)) {

            throw new \InvalidArgumentException('The HTTP status code must be of type integer, ' . gettype($code) . ' given.', 1220526013);

        }

        if ($message === null && !isset($this->statusMessages[$code])) {

            throw new \InvalidArgumentException('No message found for HTTP status code "' . $code . '".', 1220526014);

        }

        $this->statusCode = $code;

        $this->statusMessage = $message ?? $this->statusMessages[$code];

    }


    public function ‪getStatus()

    {

        return $this->statusCode . ' ' . ‪$this->statusMessage;

    }


    public function ‪getStatusCode()

    {

        return $this->statusCode ?: 200;

    }


    public function ‪setHeader($name, $value, $replaceExistingHeader = true)

    {

        if (stripos($name, 'HTTP') === 0) {

            throw new \InvalidArgumentException('The HTTP status header must be set via setStatus().', 1220541963);

        }

        if ($replaceExistingHeader === true || !isset($this->headers[$name])) {

            $this->headers[$name] = [$value];

        } else {

            $this->headers[$name][] = $value;

        }

    }


    public function ‪getHeaders()

    {

        $preparedHeaders = [];

        if ($this->statusCode !== null) {

            $protocolVersion = $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0';

            $statusHeader = $protocolVersion . ' ' . $this->statusCode . ' ' . ‪$this->statusMessage;

            $preparedHeaders[] = $statusHeader;

        }

        foreach ($this->headers as $name => $values) {

            foreach ($values as $value) {

                $preparedHeaders[] = $name . ': ' . $value;

            }

        }

        return $preparedHeaders;

    }


    public function ‪getUnpreparedHeaders(): array

    {

        return ‪$this->headers;

    }


    public function ‪sendHeaders()

    {

        if (headers_sent() === true) {

            return;

        }

        foreach ($this->‪getHeaders() as $header) {

            header($header);

        }

    }


    public function ‪send()

    {

        $this->‪sendHeaders();

        if ($this->content !== null) {

            echo $this->‪getContent();

        }

    }


    public function ‪addAdditionalHeaderData(‪$additionalHeaderData)

    {

        if (!is_string(‪$additionalHeaderData)) {

            throw new \InvalidArgumentException('The additiona header data must be of type String, ' . gettype(‪$additionalHeaderData) . ' given.', 1237370877);

        }

        if ($this->request->isCached()) {

            $pageRenderer = GeneralUtility::makeInstance(PageRenderer::class);

            $pageRenderer->addHeaderData(‪$additionalHeaderData);

        } else {

            $this->additionalHeaderData[] = ‪$additionalHeaderData;

        }

    }


    public function ‪getAdditionalHeaderData()

    {

        return ‪$this->additionalHeaderData;

    }


    public function ‪setRequest(\‪TYPO3\CMS\‪Extbase\Mvc\Web\‪Request ‪$request)

    {

        $this->request = ‪$request;

    }


    public function ‪getRequest()

    {

        return ‪$this->request;

    }


    public function ‪shutdown()

    {

        if (!empty($this->‪getAdditionalHeaderData())) {

            $this->‪getTypoScriptFrontendController()->additionalHeaderData[] = implode(LF, $this->‪getAdditionalHeaderData());

        }

        $this->‪sendHeaders();

        return parent::shutdown();

    }


    protected function ‪getTypoScriptFrontendController()

    {

        return ‪$GLOBALS['TSFE'];

    }

}