[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  declare(strict_types=1);
   4  
   5  namespace Nyholm\Psr7;
   6  
   7  use Psr\Http\Message\{ResponseInterface, StreamInterface};
   8  
   9  /**
  10   * @author Michael Dowling and contributors to guzzlehttp/psr7
  11   * @author Tobias Nyholm <[email protected]>
  12   * @author Martijn van der Ven <[email protected]>
  13   *
  14   * @final This class should never be extended. See https://github.com/Nyholm/psr7/blob/master/doc/final.md
  15   */
  16  class Response implements ResponseInterface
  17  {
  18      use MessageTrait;
  19  
  20      /** @var array Map of standard HTTP status code/reason phrases */
  21      private const PHRASES = [
  22          100 => 'Continue', 101 => 'Switching Protocols', 102 => 'Processing',
  23          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',
  24          300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 306 => 'Switch Proxy', 307 => 'Temporary Redirect',
  25          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',
  26          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',
  27      ];
  28  
  29      /** @var string */
  30      private $reasonPhrase = '';
  31  
  32      /** @var int */
  33      private $statusCode;
  34  
  35      /**
  36       * @param int $status Status code
  37       * @param array $headers Response headers
  38       * @param string|resource|StreamInterface|null $body Response body
  39       * @param string $version Protocol version
  40       * @param string|null $reason Reason phrase (when empty a default will be used based on the status code)
  41       */
  42      public function __construct(int $status = 200, array $headers = [], $body = null, string $version = '1.1', string $reason = null)
  43      {
  44          // If we got no body, defer initialization of the stream until Response::getBody()
  45          if ('' !== $body && null !== $body) {
  46              $this->stream = Stream::create($body);
  47          }
  48  
  49          $this->statusCode = $status;
  50          $this->setHeaders($headers);
  51          if (null === $reason && isset(self::PHRASES[$this->statusCode])) {
  52              $this->reasonPhrase = self::PHRASES[$status];
  53          } else {
  54              $this->reasonPhrase = $reason ?? '';
  55          }
  56  
  57          $this->protocol = $version;
  58      }
  59  
  60      public function getStatusCode(): int
  61      {
  62          return $this->statusCode;
  63      }
  64  
  65      public function getReasonPhrase(): string
  66      {
  67          return $this->reasonPhrase;
  68      }
  69  
  70      public function withStatus($code, $reasonPhrase = ''): self
  71      {
  72          if (!\is_int($code) && !\is_string($code)) {
  73              throw new \InvalidArgumentException('Status code has to be an integer');
  74          }
  75  
  76          $code = (int) $code;
  77          if ($code < 100 || $code > 599) {
  78              throw new \InvalidArgumentException(\sprintf('Status code has to be an integer between 100 and 599. A status code of %d was given', $code));
  79          }
  80  
  81          $new = clone $this;
  82          $new->statusCode = $code;
  83          if ((null === $reasonPhrase || '' === $reasonPhrase) && isset(self::PHRASES[$new->statusCode])) {
  84              $reasonPhrase = self::PHRASES[$new->statusCode];
  85          }
  86          $new->reasonPhrase = $reasonPhrase;
  87  
  88          return $new;
  89      }
  90  }