TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
Response Class Reference
Inheritance diagram for Response:
Message

Public Member Functions

 __construct ($body= 'php://temp', $statusCode=200, $headers=[])
 
 getStatusCode ()
 
 withStatus ($code, $reasonPhrase= '')
 
 getReasonPhrase ()
 
- Public Member Functions inherited from Message
 getProtocolVersion ()
 
 withProtocolVersion ($version)
 
 getHeaders ()
 
 hasHeader ($name)
 
 getHeader ($name)
 
 getHeaderLine ($name)
 
 withHeader ($name, $value)
 
 withAddedHeader ($name, $value)
 
 withoutHeader ($name)
 
 getBody ()
 
 withBody (StreamInterface $body)
 
 filter ($value)
 
 validateHeaderName ($name)
 
 isValidHeaderValue ($value)
 

Protected Attributes

 $statusCode
 
 $reasonPhrase = ''
 
 $availableStatusCodes
 
- Protected Attributes inherited from Message
 $protocolVersion = '1.1'
 
 $headers = []
 
 $lowercasedHeaderNames = []
 
 $body
 

Additional Inherited Members

- Protected Member Functions inherited from Message
 assertHeaders (array $headers)
 
 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/

Definition at line 27 of file core/Classes/Http/Response.php.

Constructor & Destructor Documentation

__construct (   $body = 'php://temp',
  $statusCode = 200,
  $headers = [] 
)

Constructor for generating new responses

Parameters
StreamInterface | string$body
int$statusCode
array$headers
Exceptions
InvalidArgumentException if any of the given arguments are given

Definition at line 119 of file core/Classes/Http/Response.php.

References Message\$body, Message\$headers, Response\$statusCode, Message\assertHeaders(), and Message\filterHeaders().

Member Function Documentation

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 200 of file core/Classes/Http/Response.php.

References Response\$reasonPhrase.

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 150 of file core/Classes/Http/Response.php.

References Response\$statusCode.

withStatus (   $code,
  $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. Response For invalid status code arguments.

Definition at line 176 of file core/Classes/Http/Response.php.

References Response\$reasonPhrase.

Member Data Documentation

$availableStatusCodes
protected
Initial value:
= [
100 => 'Continue'

Definition at line 45 of file core/Classes/Http/Response.php.

string $reasonPhrase = ''
protected

The reason phrase of the response

Definition at line 39 of file core/Classes/Http/Response.php.

Referenced by Response\getReasonPhrase(), and Response\withStatus().

int $statusCode
protected

The HTTP status code of the response

Definition at line 33 of file core/Classes/Http/Response.php.

Referenced by Response\__construct(), and Response\getStatusCode().