Overview

Namespaces

  • Docta
    • MercadoLibre
      • OAuth2
        • Client
  • GuzzleHttp
    • Cookie
    • Exception
    • Handler
    • Promise
    • Psr7
  • League
    • OAuth2
      • Client
        • Grant
          • Exception
        • Provider
          • Exception
        • Token
        • Tool
  • Psr
    • Http
      • Message

Classes

  • AppendStream
  • BufferStream
  • CachingStream
  • DroppingStream
  • FnStream
  • InflateStream
  • LazyOpenStream
  • LimitStream
  • MultipartStream
  • NoSeekStream
  • PumpStream
  • Request
  • Response
  • ServerRequest
  • Stream
  • StreamWrapper
  • UploadedFile
  • Uri
  • UriNormalizer
  • UriResolver

Traits

  • MessageTrait
  • StreamDecoratorTrait

Functions

  • build_query
  • copy_to_stream
  • copy_to_string
  • hash
  • mimetype_from_extension
  • mimetype_from_filename
  • modify_request
  • normalize_header
  • parse_header
  • parse_query
  • parse_request
  • parse_response
  • readline
  • rewind_body
  • str
  • stream_for
  • try_fopen
  • uri_for
  • Overview
  • Namespace
  • Class
  • Download

Class Response

PSR-7 response implementation.

GuzzleHttp\Psr7\Response implements Psr\Http\Message\ResponseInterface uses GuzzleHttp\Psr7\MessageTrait
Namespace: GuzzleHttp\Psr7
Located at src/Response.php
Methods summary
public
# __construct( integer $status = 200, array $headers = [], string|null|resource|Psr\Http\Message\StreamInterface $body = null, string $version = '1.1', string|null $reason = null )

Parameters

$status
Status code
$headers
Response headers
$body
Response body
$version
Protocol version
$reason
Reason phrase (when empty a default will be used based on the status code)
public integer
# getStatusCode( )

Gets the response status code.

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

integer
Status code.

Implementation of

Psr\Http\Message\ResponseInterface::getStatusCode()
public string
# getReasonPhrase( )

Gets the response reason phrase associated with the status code.

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.

Returns

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

Link

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

Implementation of

Psr\Http\Message\ResponseInterface::getReasonPhrase()
public static
# withStatus( integer $code, string $reasonPhrase = '' )

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

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.

Parameters

$code
The 3-digit integer result code to set.
$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.

Returns

static

Throws

InvalidArgumentException
For invalid status code arguments.

Link

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

Implementation of

Psr\Http\Message\ResponseInterface::withStatus()
Methods inherited from Psr\Http\Message\MessageInterface
getBody(), getHeader(), getHeaderLine(), getHeaders(), getProtocolVersion(), hasHeader(), withAddedHeader(), withBody(), withHeader(), withProtocolVersion(), withoutHeader()
Methods used from GuzzleHttp\Psr7\MessageTrait
getBody(), getHeader(), getHeaderLine(), getHeaders(), getProtocolVersion(), hasHeader(), withAddedHeader(), withBody(), withHeader(), withProtocolVersion(), withoutHeader()
MercadoLibre Provider for OAuth 2.0 Client API documentation generated by ApiGen