class Response
Same name in this branch
- 11.1.x vendor/composer/composer/src/Composer/Util/Http/Response.php \Composer\Util\Http\Response
- 11.1.x vendor/symfony/browser-kit/Response.php \Symfony\Component\BrowserKit\Response
- 11.1.x vendor/symfony/http-foundation/Response.php \Symfony\Component\HttpFoundation\Response
PSR-7 response implementation.
Hierarchy
- class \GuzzleHttp\Psr7\Response implements \Psr\Http\Message\ResponseInterface uses \GuzzleHttp\Psr7\MessageTrait
Expanded class hierarchy of Response
1 file declares its use of Response
- EasyHandle.php in vendor/
guzzlehttp/ guzzle/ src/ Handler/ EasyHandle.php
3 string references to 'Response'
- DynamicPageCacheSubscriber::onRequest in core/
modules/ dynamic_page_cache/ src/ EventSubscriber/ DynamicPageCacheSubscriber.php - Sets a response in case of a Dynamic Page Cache hit.
- DynamicPageCacheSubscriber::onResponse in core/
modules/ dynamic_page_cache/ src/ EventSubscriber/ DynamicPageCacheSubscriber.php - Stores a response in case of a Dynamic Page Cache miss, if cacheable.
- MessageFormatter::format in vendor/
guzzlehttp/ guzzle/ src/ MessageFormatter.php - Returns a formatted message string.
File
-
vendor/
guzzlehttp/ psr7/ src/ Response.php, line 13
Namespace
GuzzleHttp\Psr7View source
class Response implements ResponseInterface {
use MessageTrait;
/** Map of standard HTTP status code/reason phrases */
private const 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',
308 => 'Permanent 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',
510 => 'Not Extended',
511 => 'Network Authentication Required',
];
/** @var string */
private $reasonPhrase;
/** @var int */
private $statusCode;
/**
* @param int $status Status code
* @param (string|string[])[] $headers Response headers
* @param string|resource|StreamInterface|null $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(int $status = 200, array $headers = [], $body = null, string $version = '1.1', ?string $reason = null) {
$this->assertStatusCodeRange($status);
$this->statusCode = $status;
if ($body !== '' && $body !== null) {
$this->stream = Utils::streamFor($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() : int {
return $this->statusCode;
}
public function getReasonPhrase() : string {
return $this->reasonPhrase;
}
public function withStatus($code, $reasonPhrase = '') : ResponseInterface {
$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 = (string) $reasonPhrase;
return $new;
}
/**
* @param mixed $statusCode
*/
private function assertStatusCodeIsInteger($statusCode) : void {
if (filter_var($statusCode, FILTER_VALIDATE_INT) === false) {
throw new \InvalidArgumentException('Status code must be an integer value.');
}
}
private function assertStatusCodeRange(int $statusCode) : void {
if ($statusCode < 100 || $statusCode >= 600) {
throw new \InvalidArgumentException('Status code must be an integer value between 1xx and 5xx.');
}
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
MessageTrait::$headerNames | private | property | @var string[] Map of lowercase header name => original name at registration | |
MessageTrait::$headers | private | property | @var string[][] Map of all registered headers, as original name => array of values | |
MessageTrait::$protocol | private | property | @var string | |
MessageTrait::$stream | private | property | @var StreamInterface|null | |
MessageTrait::assertHeader | private | function | ||
MessageTrait::assertValue | private | function | field-value = *( field-content / obs-fold ) field-content = field-vchar [ 1*( SP / HTAB ) field-vchar ] field-vchar = VCHAR / obs-text VCHAR = %x21-7E obs-text = %x80-FF obs-fold = CRLF 1*( SP / HTAB ) |
|
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::trimAndValidateHeaderValues | 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::$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::PHRASES | private | constant | Map of standard HTTP status code/reason phrases | |
Response::withStatus | public | function | Return an instance with the specified status code and, optionally, reason phrase. | Overrides ResponseInterface::withStatus |
Response::__construct | public | function |