PHP Class Tebru\Retrofit\Http\Response

Author: Nate Brunette ([email protected])
Inheritance: implements Psr\Http\Message\ResponseInterface
ファイルを表示 Open project: tebru/retrofit-php Class Usage Examples

Public Methods

Method Description
__construct ( Psr\Http\Message\ResponseInterface $response, string $returnType, Tebru\Retrofit\Adapter\DeserializerAdapter $deserializerAdapter = null, array $context = [] ) Constructor
body ( ) : mixed Get the body specified by the Returns annotation
getBody ( ) : Psr\Http\Message\StreamInterface Gets the body of the message.
getHeader ( string $name ) : string[] Retrieves a message header value by the given case-insensitive name.
getHeaderLine ( string $name ) : string Retrieves a comma-separated string of the values for a single header.
getHeaders ( ) : array Retrieves all message header values.
getProtocolVersion ( ) : string Retrieves the HTTP protocol version as a string.
getReasonPhrase ( ) : string Gets the response reason phrase associated with the status code.
getStatusCode ( ) : integer Gets the response status code.
hasHeader ( string $name ) : boolean Checks if a header exists by the given case-insensitive name.
withAddedHeader ( string $name, string | string[] $value ) : self Return an instance with the specified header appended with the given value.
withBody ( Psr\Http\Message\StreamInterface $body ) : self Return an instance with the specified message body.
withHeader ( string $name, string | string[] $value ) : self Return an instance with the provided value replacing the specified header.
withProtocolVersion ( string $version ) : self Return an instance with the specified HTTP protocol version.
withStatus ( integer $code, string $reasonPhrase = '' ) : self Return an instance with the specified status code and, optionally, reason phrase.
withoutHeader ( string $name ) : self Return an instance without the specified header.

Method Details

__construct() public method

Constructor
public __construct ( Psr\Http\Message\ResponseInterface $response, string $returnType, Tebru\Retrofit\Adapter\DeserializerAdapter $deserializerAdapter = null, array $context = [] )
$response Psr\Http\Message\ResponseInterface
$returnType string
$deserializerAdapter Tebru\Retrofit\Adapter\DeserializerAdapter
$context array

body() public method

Get the body specified by the Returns annotation
public body ( ) : mixed
return mixed

getBody() public method

Gets the body of the message.
public getBody ( ) : Psr\Http\Message\StreamInterface
return Psr\Http\Message\StreamInterface Returns the body as a stream.

getHeader() public method

This method returns an array of all the header values of the given case-insensitive header name. If the header does not appear in the message, this method MUST return an empty array.
public getHeader ( string $name ) : string[]
$name string Case-insensitive header field name.
return string[] An array of string values as provided for the given header. If the header does not appear in the message, this method MUST return an empty array.

getHeaderLine() public method

This method returns all of the header values of the given case-insensitive header name as a string concatenated together using a comma. NOTE: Not all header values may be appropriately represented using comma concatenation. For such headers, use getHeader() instead and supply your own delimiter when concatenating. If the header does not appear in the message, this method MUST return an empty string.
public getHeaderLine ( string $name ) : string
$name string Case-insensitive header field name.
return string A string of values as provided for the given header concatenated together using a comma. If the header does not appear in the message, this method MUST return an empty string.

getHeaders() public method

The keys represent the header name as it will be sent over the wire, and each value is an array of strings associated with the header. Represent the headers as a string foreach ($message->getHeaders() as $name => $values) { echo $name . ": " . implode(", ", $values); } Emit headers iteratively: foreach ($message->getHeaders() as $name => $values) { foreach ($values as $value) { header(sprintf('%s: %s', $name, $value), false); } } While header names are not case-sensitive, getHeaders() will preserve the exact case in which headers were originally specified.
public getHeaders ( ) : array
return array Returns an associative array of the message's headers. Each key MUST be a header name, and each value MUST be an array of strings for that header.

getProtocolVersion() public method

The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").
public getProtocolVersion ( ) : string
return string HTTP protocol version.

getReasonPhrase() public method

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.
See link: http://tools.ietf.org/html/rfc7231#section-6
See link: http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
public getReasonPhrase ( ) : string
return string Reason phrase; must return an empty string if none present.

getStatusCode() public method

The status code is a 3-digit integer result code of the server's attempt to understand and satisfy the request.
public getStatusCode ( ) : integer
return integer Status code.

hasHeader() public method

Checks if a header exists by the given case-insensitive name.
public hasHeader ( string $name ) : boolean
$name string Case-insensitive header field name.
return boolean Returns true if any header names match the given header name using a case-insensitive string comparison. Returns false if no matching header name is found in the message.

withAddedHeader() public method

Existing values for the specified header will be maintained. The new value(s) will be appended to the existing list. If the header did not exist previously, it will be added. 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 new header and/or value.
public withAddedHeader ( string $name, string | string[] $value ) : self
$name string Case-insensitive header field name to add.
$value string | string[] Header value(s).
return self

withBody() public method

The body MUST be a StreamInterface object. This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return a new instance that has the new body stream.
public withBody ( Psr\Http\Message\StreamInterface $body ) : self
$body Psr\Http\Message\StreamInterface Body.
return self

withHeader() public method

While header names are case-insensitive, the casing of the header will be preserved by this function, and returned from getHeaders(). 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 new and/or updated header and value.
public withHeader ( string $name, string | string[] $value ) : self
$name string Case-insensitive header field name.
$value string | string[] Header value(s).
return self

withProtocolVersion() public method

The version string MUST contain only the HTTP version number (e.g., "1.1", "1.0"). 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 new protocol version.
public withProtocolVersion ( string $version ) : self
$version string HTTP protocol version
return self

withStatus() public method

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.
See link: http://tools.ietf.org/html/rfc7231#section-6
See link: http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
public withStatus ( integer $code, string $reasonPhrase = '' ) : self
$code integer The 3-digit integer result code to set.
$reasonPhrase string 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.
return self

withoutHeader() public method

Header resolution MUST be done without case-sensitivity. This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that removes the named header.
public withoutHeader ( string $name ) : self
$name string Case-insensitive header field name to remove.
return self