interface ResponseInterface

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.

Hierarchy

Expanded class hierarchy of ResponseInterface

All classes that implement ResponseInterface

39 files declare their use of ResponseInterface
BadResponseException.php in vendor/guzzlehttp/guzzle/src/Exception/BadResponseException.php
Client.php in vendor/php-http/guzzle7-adapter/src/Client.php
Client.php in vendor/guzzlehttp/guzzle/src/Client.php
ClientInterface.php in vendor/guzzlehttp/guzzle/src/ClientInterface.php
ClientInterface.php in vendor/psr/http-client/src/ClientInterface.php

... See full list

File

vendor/psr/http-message/src/ResponseInterface.php, line 20

Namespace

Psr\Http\Message
View source 
interface ResponseInterface extends MessageInterface {
    
    /**
     * 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 int Status code.
     */
    public function getStatusCode() : int;
    
    /**
     * 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.
     *
     * @link http://tools.ietf.org/html/rfc7231#section-6
     * @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
     * @param int $code The 3-digit integer result code to set.
     * @param 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 static
     * @throws \InvalidArgumentException For invalid status code arguments.
     */
    public function withStatus(int $code, string $reasonPhrase = '') : ResponseInterface;
    
    /**
     * 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.
     *
     * @link http://tools.ietf.org/html/rfc7231#section-6
     * @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
     * @return string Reason phrase; must return an empty string if none present.
     */
    public function getReasonPhrase() : string;

}

Members

Title Modifiers Object type Summary Overrides
MessageInterface::getBody public function Gets the body of the message.
MessageInterface::getHeader public function Retrieves a message header value by the given case-insensitive name.
MessageInterface::getHeaderLine public function Retrieves a comma-separated string of the values for a single header.
MessageInterface::getHeaders public function Retrieves all message header values.
MessageInterface::getProtocolVersion public function Retrieves the HTTP protocol version as a string.
MessageInterface::hasHeader public function Checks if a header exists by the given case-insensitive name.
MessageInterface::withAddedHeader public function Return an instance with the specified header appended with the given value.
MessageInterface::withBody public function Return an instance with the specified message body.
MessageInterface::withHeader public function Return an instance with the provided value replacing the specified header.
MessageInterface::withoutHeader public function Return an instance without the specified header.
MessageInterface::withProtocolVersion public function Return an instance with the specified HTTP protocol version.
ResponseInterface::getReasonPhrase public function Gets the response reason phrase associated with the status code. 1
ResponseInterface::getStatusCode public function Gets the response status code. 1
ResponseInterface::withStatus public function Return an instance with the specified status code and, optionally, reason phrase. 1