TYPO3\CMS\Core\Http\Response Class Reference

Inheritance diagram for TYPO3\CMS\Core\Http\Response:

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

Static Public Member Functions
static	withStatus ($code, $reasonPhrase='')
‪Static Public Member Functions inherited from ‪TYPO3\CMS\Core\Http\Message
static	withProtocolVersion ($version)
static	withHeader ($name, $value)
static	withAddedHeader ($name, $value)
static	withoutHeader ($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( )
array	$lowercasedHeaderNames = array( )
StreamInterface	$body

Additional Inherited Members
‪Protected Member Functions inherited from ‪TYPO3\CMS\Core\Http\Message
	assertHeaders (array $headers)
array	filterHeaders (array $originalHeaders)
bool	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 yet.

Definition at line 29 of file Response.php.

Constructor & Destructor Documentation

__construct()

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

Constructor for generating new responses

Parameters

StreamInterface | string | null	$body
int	$statusCode
array	$headers
string	$reasonPhrase

Exceptions

Definition at line 125 of file Response.php.

References TYPO3\CMS\Core\Http\Message\$body, TYPO3\CMS\Core\Http\Message\$headers, TYPO3\CMS\Core\Http\Message\$lowercasedHeaderNames, TYPO3\CMS\Core\Http\Response\$reasonPhrase, TYPO3\CMS\Core\Http\Response\$statusCode, TYPO3\CMS\Core\Http\Message\assertHeaders(), TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), and TYPO3\CMS\Core\Http\Message\filterHeaders().

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\testCanSetCustomReasonPhrase(), and TYPO3\CMS\Core\Tests\Unit\Http\ResponseTest\testReasonPhraseDefaultsToStandards().

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.

Returns

‪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\testConstructorCanAcceptAllMessageParts(), and TYPO3\CMS\Core\Tests\Unit\Http\ResponseTest\testStatusCodeMutatorReturnsCloneWithChanges().

withStatus()

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

static

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, and TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger().

Referenced by TYPO3\CMS\Core\Tests\Unit\Http\ResponseTest\testCanSetCustomReasonPhrase(), TYPO3\CMS\Core\Tests\Unit\Http\ResponseTest\testReasonPhraseDefaultsToStandards(), and TYPO3\CMS\Core\Tests\Unit\Http\ResponseTest\testStatusCodeMutatorReturnsCloneWithChanges().

Member Data Documentation

$availableStatusCodes

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

protected

The standardized and other important HTTP Status Codes

Definition at line 44 of file Response.php.

$reasonPhrase

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

protected

The reason phrase of the response $reasonPhrase

Definition at line 39 of file Response.php.

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

$statusCode

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

protected

The HTTP status code of the response $statusCode

Definition at line 34 of file Response.php.

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