Response.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\Core\Http;
 
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\StreamInterface;
use ‪TYPO3\CMS\Core\Utility\MathUtility;
 
class ‪Response extends ‪Message implements ResponseInterface
{
    protected int ‪$statusCode;
 
    protected string ‪$reasonPhrase = '';
 
    protected array ‪$availableStatusCodes = [
        // 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 => 'Payload Too Large',
        414 => 'URI Too Long',
        415 => 'Unsupported Media Type',
        416 => 'Range Not Satisfiable',
        417 => 'Expectation Failed',
        418 => 'I\'m a teapot',
        421 => 'Misdirected Request',
        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 Timeout',
        505 => 'HTTP Version Not Supported',
        506 => 'Variant Also Negotiates',
        507 => 'Insufficient Storage',
        508 => 'Loop Detected',
        509 => 'Bandwidth Limit Exceeded',
        510 => 'Not Extended',
        511 => 'Network Authentication Required',
    ];
 
    public function ‪__construct(‪$body = 'php://temp', int ‪$statusCode = 200, array ‪$headers = [], string ‪$reasonPhrase = '')
    {
        // Build a streamable object for the body
        if (‪$body !== null && !is_string(‪$body) && !is_resource(‪$body) && !‪$body instanceof StreamInterface) {
            throw new \InvalidArgumentException('Body must be a string stream resource identifier, a stream resource, or a StreamInterface instance', 1436717277);
        }
 
        if (‪$body !== null && !‪$body instanceof StreamInterface) {
            ‪$body = new ‪Stream(‪$body, 'rw');
        }
        $this->body = ‪$body;
 
        if (‪MathUtility::canBeInterpretedAsInteger(‪$statusCode) === false || !array_key_exists((int)‪$statusCode, $this->availableStatusCodes)) {
            throw new \InvalidArgumentException('The given status code is not a valid HTTP status code.', 1436717278);
        }
        $this->statusCode = ‪$statusCode;
 
        $this->reasonPhrase = ‪$reasonPhrase === '' ? $this->availableStatusCodes[‪$this->statusCode] : ‪$reasonPhrase;
        [‪$this->lowercasedHeaderNames, ‪$headers] = $this->‪filterHeaders(‪$headers);
        $this->‪assertHeaders(‪$headers);
        $this->headers = ‪$headers;
    }
 
    public function ‪getStatusCode(): int
    {
        return ‪$this->statusCode;
    }
 
    public function ‪withStatus(int $code, string ‪$reasonPhrase = ''): ResponseInterface
    {
        if (!array_key_exists((int)$code, $this->availableStatusCodes)) {
            throw new \InvalidArgumentException('The given status code is not a valid HTTP status code', 1436717279);
        }
        $clonedObject = clone $this;
        $clonedObject->statusCode = (int)$code;
        $clonedObject->reasonPhrase = ‪$reasonPhrase !== '' ? ‪$reasonPhrase : $this->availableStatusCodes[$code];
        return $clonedObject;
    }
 
    public function ‪getReasonPhrase(): string
    {
        return ‪$this->reasonPhrase;
    }
}