Menu

## ResponseInterface extends MessageInterface
in

ResponseInterface.php : 19

Representation of an outgoing, server-side response.

Per the HTTP specification, this interface includes properties for each of the following:

- Protocol version
- Status code and reason phrase
- Headers
- Message body

Responses are considered immutable; all methods that might change state MUST be implemented such that they retain the internal state of the current message and return an instance that contains the changed state.

### Table of Contents

getBody() : StreamInterface
  Gets the body of the message.
getHeader() : array<string|int, string>
  Retrieves a message header value by the given case-insensitive name.
getHeaderLine() : string
  Retrieves a comma-separated string of the values for a single header.
getHeaders() : array<string|int, mixed>
  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() : int
  Gets the response status code.
hasHeader() : bool
  Checks if a header exists by the given case-insensitive name.
withAddedHeader() : static
  Return an instance with the specified header appended with the given value.
withBody() : static
  Return an instance with the specified message body.
withHeader() : static
  Return an instance with the provided value replacing the specified header.
withoutHeader() : static
  Return an instance without the specified header.
withProtocolVersion() : static
  Return an instance with the specified HTTP protocol version.
withStatus() : static
  Return an instance with the specified status code and, optionally, reason phrase.

### Methods

#### getBody()

MessageInterface.php : 183

Gets the body of the message.

`public getBody() : StreamInterface`

##### Return values

StreamInterface —

returns the body as a stream

#### getHeader()

MessageInterface.php : 99

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

`public getHeader(string $name) : array<string|int, string>`

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.

header. If the header does not appear in the message, this method MUST return an empty array.

##### Parameters

$name : string

  case-insensitive header field name

##### Return values

array<string|int, string> —

An array of string values as provided for the given

#### getHeaderLine()

MessageInterface.php : 122

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

`public getHeaderLine(string $name) : string`

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.

concatenated together using a comma. If the header does not appear in the message, this method MUST return an empty string.

##### Parameters

$name : string

  case-insensitive header field name

##### Return values

string —

A string of values as provided for the given header

#### getHeaders()

MessageInterface.php : 69

Retrieves all message header values.

`public getHeaders() : array<string|int, mixed>`

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.

    key MUST be a header name, and each value MUST be an array of strings
    for that header.

##### Return values

array<string|int, mixed> —

Returns an associative array of the message's headers. Each

#### getProtocolVersion()

MessageInterface.php : 25

Retrieves the HTTP protocol version as a string.

`public getProtocolVersion() : string`

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

##### Return values

string —

HTTP protocol version

#### getReasonPhrase()

ResponseInterface.php : 71

Gets the response reason phrase associated with the status code.

`public getReasonPhrase() : string`

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.

##### Tags

see
  http://tools.ietf.org/html/rfc7231#section-6
see
  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

#### getStatusCode()

ResponseInterface.php : 29

Gets the response status code.

`public getStatusCode() : int`

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

#### hasHeader()

MessageInterface.php : 81

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

`public hasHeader(string $name) : bool`

name using a case-insensitive string comparison. Returns false if no matching header name is found in the message.

##### Parameters

$name : string

  case-insensitive header field name

##### Return values

bool —

Returns true if any header names match the given header

#### withAddedHeader()

MessageInterface.php : 161

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

`public withAddedHeader(string $name, string|array<string|int, string> $value) : static`

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

$name : string

  case-insensitive header field name to add

$value : string|array<string|int, string>

  header value(s)

##### Tags

throws
  InvalidArgumentException

  for invalid header names or values

##### Return values

static —

#### withBody()

MessageInterface.php : 200

Return an instance with the specified message body.

`public withBody(StreamInterface $body) : static`

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

$body : StreamInterface

  body

##### Tags

throws
  InvalidArgumentException

  when the body is not valid

##### Return values

static —

#### withHeader()

MessageInterface.php : 141

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

`public withHeader(string $name, string|array<string|int, string> $value) : static`

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

$name : string

  case-insensitive header field name

$value : string|array<string|int, string>

  header value(s)

##### Tags

throws
  InvalidArgumentException

  for invalid header names or values

##### Return values

static —

#### withoutHeader()

MessageInterface.php : 176

Return an instance without the specified header.

`public withoutHeader(string $name) : static`

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

$name : string

  case-insensitive header field name to remove

##### Return values

static —

#### withProtocolVersion()

MessageInterface.php : 41

Return an instance with the specified HTTP protocol version.

`public withProtocolVersion(string $version) : static`

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

$version : string

  HTTP protocol version

##### Return values

static —

#### withStatus()

ResponseInterface.php : 55

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

`public withStatus(int $code[, string $reasonPhrase = '' ]) : static`

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.

    provided status code; if none is provided, implementations MAY
    use the defaults as suggested in the HTTP specification.

##### Parameters

$code : int

  the 3-digit integer result code to set

$reasonPhrase : string = ''

  The reason phrase to use with the

##### Tags

see
  http://tools.ietf.org/html/rfc7231#section-6
see
  http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
throws
  InvalidArgumentException

  for invalid status code arguments

##### Return values

static —

## Search results