class Response in Auth0 Single Sign On 8.2

PSR-7 response implementation.

Hierarchy

• class \GuzzleHttp\Psr7\Response implements ResponseInterface uses MessageTrait

13 files declare their use of Response

Auth0Test.php in vendor/auth0/auth0-php/tests/Auth0Test.php

BlacklistsTest.php in vendor/auth0/auth0-php/tests/API/Management/BlacklistsTest.php

ClientsTest.php in vendor/auth0/auth0-php/tests/API/Management/ClientsTest.php

ConnectionsMockedTest.php in vendor/auth0/auth0-php/tests/API/Management/ConnectionsMockedTest.php

EasyHandle.php in vendor/guzzlehttp/guzzle/src/Handler/EasyHandle.php

... See full list

File

vendor/guzzlehttp/psr7/src/Response.php, line 10

Namespace

GuzzleHttp\Psr7

class Response implements ResponseInterface {
  use MessageTrait;

  /** @var array Map of standard HTTP status code/reason phrases */
  private static $phrases = [
    100 => 'Continue',
    101 => 'Switching Protocols',
    102 => 'Processing',
    200 => 'OK',
    201 => 'Created',
    202 => 'Accepted',
    203 => 'Non-Authoritative Information',
    204 => 'No Content',
    205 => 'Reset Content',
    206 => 'Partial Content',
    207 => 'Multi-status',
    208 => 'Already Reported',
    300 => 'Multiple Choices',
    301 => 'Moved Permanently',
    302 => 'Found',
    303 => 'See Other',
    304 => 'Not Modified',
    305 => 'Use Proxy',
    306 => 'Switch Proxy',
    307 => 'Temporary Redirect',
    400 => 'Bad Request',
    401 => 'Unauthorized',
    402 => 'Payment Required',
    403 => 'Forbidden',
    404 => 'Not Found',
    405 => 'Method Not Allowed',
    406 => 'Not Acceptable',
    407 => 'Proxy Authentication Required',
    408 => 'Request Time-out',
    409 => 'Conflict',
    410 => 'Gone',
    411 => 'Length Required',
    412 => 'Precondition Failed',
    413 => 'Request Entity Too Large',
    414 => 'Request-URI Too Large',
    415 => 'Unsupported Media Type',
    416 => 'Requested range not satisfiable',
    417 => 'Expectation Failed',
    418 => 'I\'m a teapot',
    422 => 'Unprocessable Entity',
    423 => 'Locked',
    424 => 'Failed Dependency',
    425 => 'Unordered Collection',
    426 => 'Upgrade Required',
    428 => 'Precondition Required',
    429 => 'Too Many Requests',
    431 => 'Request Header Fields Too Large',
    451 => 'Unavailable For Legal Reasons',
    500 => 'Internal Server Error',
    501 => 'Not Implemented',
    502 => 'Bad Gateway',
    503 => 'Service Unavailable',
    504 => 'Gateway Time-out',
    505 => 'HTTP Version not supported',
    506 => 'Variant Also Negotiates',
    507 => 'Insufficient Storage',
    508 => 'Loop Detected',
    511 => 'Network Authentication Required',
  ];

  /** @var string */
  private $reasonPhrase = '';

  /** @var int */
  private $statusCode = 200;

  /**
   * @param int                                  $status  Status code
   * @param array                                $headers Response headers
   * @param string|null|resource|StreamInterface $body    Response body
   * @param string                               $version Protocol version
   * @param string|null                          $reason  Reason phrase (when empty a default will be used based on the status code)
   */
  public function __construct($status = 200, array $headers = [], $body = null, $version = '1.1', $reason = null) {
    $this
      ->assertStatusCodeIsInteger($status);
    $status = (int) $status;
    $this
      ->assertStatusCodeRange($status);
    $this->statusCode = $status;
    if ($body !== '' && $body !== null) {
      $this->stream = stream_for($body);
    }
    $this
      ->setHeaders($headers);
    if ($reason == '' && isset(self::$phrases[$this->statusCode])) {
      $this->reasonPhrase = self::$phrases[$this->statusCode];
    }
    else {
      $this->reasonPhrase = (string) $reason;
    }
    $this->protocol = $version;
  }
  public function getStatusCode() {
    return $this->statusCode;
  }
  public function getReasonPhrase() {
    return $this->reasonPhrase;
  }
  public function withStatus($code, $reasonPhrase = '') {
    $this
      ->assertStatusCodeIsInteger($code);
    $code = (int) $code;
    $this
      ->assertStatusCodeRange($code);
    $new = clone $this;
    $new->statusCode = $code;
    if ($reasonPhrase == '' && isset(self::$phrases[$new->statusCode])) {
      $reasonPhrase = self::$phrases[$new->statusCode];
    }
    $new->reasonPhrase = $reasonPhrase;
    return $new;
  }
  private function assertStatusCodeIsInteger($statusCode) {
    if (filter_var($statusCode, FILTER_VALIDATE_INT) === false) {
      throw new \InvalidArgumentException('Status code must be an integer value.');
    }
  }
  private function assertStatusCodeRange($statusCode) {
    if ($statusCode < 100 || $statusCode >= 600) {
      throw new \InvalidArgumentException('Status code must be an integer value between 1xx and 5xx.');
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MessageTrait::$headerNames	private	property	@var array Map of lowercase header name => original name at registration
MessageTrait::$headers	private	property	@var array Map of all registered headers, as original name => array of values
MessageTrait::$protocol	private	property	@var string
MessageTrait::$stream	private	property	@var StreamInterface
MessageTrait::assertHeader	private	function
MessageTrait::getBody	public	function
MessageTrait::getHeader	public	function
MessageTrait::getHeaderLine	public	function
MessageTrait::getHeaders	public	function
MessageTrait::getProtocolVersion	public	function
MessageTrait::hasHeader	public	function
MessageTrait::normalizeHeaderValue	private	function
MessageTrait::setHeaders	private	function
MessageTrait::trimHeaderValues	private	function	Trims whitespace from the header values.
MessageTrait::withAddedHeader	public	function
MessageTrait::withBody	public	function
MessageTrait::withHeader	public	function
MessageTrait::withoutHeader	public	function
MessageTrait::withProtocolVersion	public	function
Response::$phrases	private static	property	@var array Map of standard HTTP status code/reason phrases
Response::$reasonPhrase	private	property	@var string
Response::$statusCode	private	property	@var int
Response::assertStatusCodeIsInteger	private	function
Response::assertStatusCodeRange	private	function
Response::getReasonPhrase	public	function	Gets the response reason phrase associated with the status code. Overrides ResponseInterface::getReasonPhrase
Response::getStatusCode	public	function	Gets the response status code. Overrides ResponseInterface::getStatusCode
Response::withStatus	public	function	Return an instance with the specified status code and, optionally, reason phrase. Overrides ResponseInterface::withStatus
Response::__construct	public	function