Inheritance diagram for GuzzleHttp\Psr7\Response:

Public Member Functions
	__construct (int $status=200, array $headers=[], $body=null, string $version='1.1', string $reason=null)

	getBody ()
	Gets the body of the message.

	getHeader ($name)
	Retrieves a message header value by the given case-insensitive name.

	getHeaderLine ($name)
	Retrieves a comma-separated string of the values for a single header.

	getHeaders ()
	Retrieves all message header values.

	getProtocolVersion ()
	Retrieves the HTTP protocol version as a string.

	getReasonPhrase ()
	Gets the response reason phrase associated with the status code.

	getStatusCode ()
	Gets the response status code.

	hasHeader ($name)
	Checks if a header exists by the given case-insensitive name.

	withAddedHeader ($name, $value)
	Return an instance with the specified header appended with the given value.

	withBody (StreamInterface $body)
	Return an instance with the specified message body.

	withHeader ($name, $value)
	Return an instance with the provided value replacing the specified header.

	withoutHeader ($name)
	Return an instance without the specified header.

	withProtocolVersion ($version)
	Return an instance with the specified HTTP protocol version.

	withStatus ($code, $reasonPhrase='')
	Return an instance with the specified status code and, optionally, reason phrase.

Constructor & Destructor Documentation

◆ __construct()

GuzzleHttp\Psr7\Response::__construct	(	int	$status = 200,
		array	$headers = [],
			$body = null,
		string	$version = '1.1',
		string	$reason = null )

Parameters

int	$status	Status code
	array<string,string\|string[]>	$headers Response headers
string \| resource \| StreamInterface \| null	$body	Response body
string	$version	Protocol version
string \| null	$reason	Reason phrase (when empty a default will be used based on the status code)

Member Function Documentation

◆ getBody()

Psr\Http\Message\MessageInterface::getBody ( )

inherited

Gets the body of the message.

Return values

StreamInterface Returns the body as a stream.

◆ getHeader()

Psr\Http\Message\MessageInterface::getHeader ( $name )

inherited

Retrieves a message header value by the given case-insensitive name.

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.

Parameters

string $name Case-insensitive header field name.

Return values

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()

Psr\Http\Message\MessageInterface::getHeaderLine ( $name )

inherited

Retrieves a comma-separated string of the values for a single header.

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.

Parameters

string $name Case-insensitive header field name.

Return values

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()

Psr\Http\Message\MessageInterface::getHeaders ( )

inherited

Retrieves all message header values.

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.

Return values

string[][] 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()

Psr\Http\Message\MessageInterface::getProtocolVersion ( )

inherited

Retrieves the HTTP protocol version as a string.

The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").

Return values

string HTTP protocol version.

◆ getReasonPhrase()

GuzzleHttp\Psr7\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.

@externalurl http://tools.ietf.org/html/rfc7231#section-6 @externalurl http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

Return values

string Reason phrase; must return an empty string if none present.

Implements Psr\Http\Message\ResponseInterface.

◆ getStatusCode()

GuzzleHttp\Psr7\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.

Return values

int	Status code.

Implements Psr\Http\Message\ResponseInterface.

◆ hasHeader()

Psr\Http\Message\MessageInterface::hasHeader ( $name )

inherited

Checks if a header exists by the given case-insensitive name.

Parameters

string $name Case-insensitive header field name.

Return values

bool	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()

Psr\Http\Message\MessageInterface::withAddedHeader	(		$name,
			$value )

inherited

Return an instance with the specified header appended with the given value.

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.

Parameters

string	$name	Case-insensitive header field name to add.
string \| string[]	$value	Header value(s).

Return values

static

Exceptions

InvalidArgumentException for invalid header names or values.

◆ withBody()

Psr\Http\Message\MessageInterface::withBody ( StreamInterface $body )

inherited

Return an instance with the specified message body.

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.

Parameters

StreamInterface $body Body.

Return values

static

Exceptions

InvalidArgumentException When the body is not valid.

◆ withHeader()

Psr\Http\Message\MessageInterface::withHeader	(		$name,
			$value )

inherited

Return an instance with the provided value replacing the specified header.

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.

Parameters

string	$name	Case-insensitive header field name.
string \| string[]	$value	Header value(s).

Return values

static

Exceptions

InvalidArgumentException for invalid header names or values.

◆ withoutHeader()

Psr\Http\Message\MessageInterface::withoutHeader ( $name )

inherited

Return an instance without the specified header.

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.

Parameters

string $name Case-insensitive header field name to remove.

Return values

static

◆ withProtocolVersion()

Psr\Http\Message\MessageInterface::withProtocolVersion ( $version )

inherited

Return an instance with the specified HTTP protocol version.

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.

Parameters

string $version HTTP protocol version

Return values

static

◆ withStatus()

GuzzleHttp\Psr7\Response::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.

@externalurl http://tools.ietf.org/html/rfc7231#section-6 @externalurl http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

Parameters

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.

Return values

static

Exceptions

InvalidArgumentException For invalid status code arguments.

Implements Psr\Http\Message\ResponseInterface.

The documentation for this class was generated from the following file:

lib/guzzlehttp/psr7/src/Response.php

Public Member Functions

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getBody()

◆ getHeader()

◆ getHeaderLine()

◆ getHeaders()

◆ getProtocolVersion()

◆ getReasonPhrase()

◆ getStatusCode()

◆ hasHeader()

◆ withAddedHeader()

◆ withBody()

◆ withHeader()

◆ withoutHeader()

◆ withProtocolVersion()

◆ withStatus()