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