Response.php 4.2 KB

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