‪TYPO3CMS  ‪main
TYPO3\CMS\Core\Http\Response Class Reference
Inheritance diagram for TYPO3\CMS\Core\Http\Response:
TYPO3\CMS\Core\Http\Message TYPO3\CMS\Core\Http\HtmlResponse TYPO3\CMS\Core\Http\JsonResponse TYPO3\CMS\Core\Http\NullResponse TYPO3\CMS\Core\Http\RedirectResponse TYPO3\CMS\Extbase\Http\ForwardResponse

Public Member Functions

 __construct ($body='php://temp', int $statusCode=200, array $headers=[], string $reasonPhrase='')
int getStatusCode ()
string getReasonPhrase ()
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Http\Message
string getProtocolVersion ()
array getHeaders ()
bool hasHeader (string $name)
string[] getHeader (string $name)
string getHeaderLine (string $name)
StreamInterface getBody ()
 filter (string $value)
 validateHeaderName (string $name)
 isValidHeaderValue (string $value)

Static Public Member Functions

static withStatus (int $code, string $reasonPhrase='')
- ‪Static Public Member Functions inherited from ‪TYPO3\CMS\Core\Http\Message
static withProtocolVersion (string $version)
static withHeader (string $name, $value)
static withAddedHeader (string $name, $value)
static withoutHeader (string $name)
static withBody (StreamInterface $body)

Protected Attributes

int $statusCode
string $reasonPhrase = ''
array $availableStatusCodes
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Core\Http\Message
string $protocolVersion = '1.1'
array $headers = []
array $lowercasedHeaderNames = []
StreamInterface $body = null

Additional Inherited Members

- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Core\Http\Message
 assertHeaders (array $headers)
array filterHeaders (array $originalHeaders)
 arrayContainsOnlyStrings (array $data)
 validateHeaderValues (array $values)

Detailed Description

Default implementation for the ResponseInterface of the PSR-7 standard.

Highly inspired by https://github.com/phly/http/

Note that this is not public API, use PSR-17 interfaces instead

Definition at line 31 of file Response.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Http\Response::__construct (   $body = 'php://temp',
int  $statusCode = 200,
array  $headers = [],
string  $reasonPhrase = '' 

Member Function Documentation

◆ getReasonPhrase()

string TYPO3\CMS\Core\Http\Response::getReasonPhrase ( )

Gets the response reason phrase associated with the status code.

Because a reason phrase is not a required element in a response status line, the reason phrase value MAY be null. Implementations MAY choose to return the default RFC 7231 recommended reason phrase (or those listed in the IANA HTTP Status Code Registry) for the response's status code.

http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml string Reason phrase; must return an empty string if none present.

Definition at line 206 of file Response.php.

References TYPO3\CMS\Core\Http\Response\$reasonPhrase.

Referenced by TYPO3\CMS\Core\Tests\Unit\Http\ResponseTest\canSetCustomReasonPhrase(), and TYPO3\CMS\Core\Tests\Unit\Http\ResponseTest\reasonPhraseDefaultsToStandards().

◆ getStatusCode()

int TYPO3\CMS\Core\Http\Response::getStatusCode ( )

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.

‪int Status code.

Definition at line 156 of file Response.php.

References TYPO3\CMS\Core\Http\Response\$statusCode.

Referenced by TYPO3\CMS\Core\Tests\Unit\Http\ResponseTest\constructorCanAcceptAllMessageParts(), and TYPO3\CMS\Core\Tests\Unit\Http\ResponseTest\statusCodeMutatorReturnsCloneWithChanges().

◆ withStatus()

static TYPO3\CMS\Core\Http\Response::withStatus ( int  $code,
string  $reasonPhrase = '' 

Return an instance with the specified status code and, optionally, reason phrase.

If no reason phrase is specified, implementations MAY choose to default to the RFC 7231 or IANA recommended reason phrase for the response's status code.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the updated status and reason phrase.

http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml int $code The 3-digit integer result code to set. 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. static For invalid status code arguments.

Definition at line 182 of file Response.php.

References TYPO3\CMS\Core\Http\Response\$reasonPhrase.

Referenced by TYPO3\CMS\Core\Tests\Unit\Http\ResponseTest\canSetCustomReasonPhrase(), TYPO3\CMS\Core\Tests\Unit\Http\ResponseTest\reasonPhraseDefaultsToStandards(), and TYPO3\CMS\Core\Tests\Unit\Http\ResponseTest\statusCodeMutatorReturnsCloneWithChanges().

Member Data Documentation

◆ $availableStatusCodes

array TYPO3\CMS\Core\Http\Response::$availableStatusCodes

Definition at line 47 of file Response.php.

◆ $reasonPhrase

string TYPO3\CMS\Core\Http\Response::$reasonPhrase = ''

◆ $statusCode

int TYPO3\CMS\Core\Http\Response::$statusCode

The HTTP status code of the response

Definition at line 36 of file Response.php.

Referenced by TYPO3\CMS\Core\Http\Response\__construct(), and TYPO3\CMS\Core\Http\Response\getStatusCode().