451 lines
13 KiB
PHP
451 lines
13 KiB
PHP
<?php
|
|
/**
|
|
* Slim Framework (http://slimframework.com)
|
|
*
|
|
* @link https://github.com/slimphp/Slim
|
|
* @copyright Copyright (c) 2011-2015 Josh Lockhart
|
|
* @license https://github.com/slimphp/Slim/blob/3.x/LICENSE.md (MIT License)
|
|
*/
|
|
namespace Slim\Http;
|
|
|
|
use InvalidArgumentException;
|
|
use Psr\Http\Message\ResponseInterface;
|
|
use Psr\Http\Message\StreamInterface;
|
|
use Psr\Http\Message\UriInterface;
|
|
use Slim\Interfaces\Http\HeadersInterface;
|
|
|
|
/**
|
|
* Response
|
|
*
|
|
* This class represents an HTTP response. It manages
|
|
* the response status, headers, and body
|
|
* according to the PSR-7 standard.
|
|
*
|
|
* @link https://github.com/php-fig/http-message/blob/master/src/MessageInterface.php
|
|
* @link https://github.com/php-fig/http-message/blob/master/src/ResponseInterface.php
|
|
*/
|
|
class Response extends Message implements ResponseInterface
|
|
{
|
|
/**
|
|
* Status code
|
|
*
|
|
* @var int
|
|
*/
|
|
protected $status = 200;
|
|
|
|
/**
|
|
* Reason phrase
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $reasonPhrase = '';
|
|
|
|
/**
|
|
* Status codes and reason phrases
|
|
*
|
|
* @var array
|
|
*/
|
|
protected static $messages = [
|
|
//Informational 1xx
|
|
100 => 'Continue',
|
|
101 => 'Switching Protocols',
|
|
102 => 'Processing',
|
|
//Successful 2xx
|
|
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',
|
|
226 => 'IM Used',
|
|
//Redirection 3xx
|
|
300 => 'Multiple Choices',
|
|
301 => 'Moved Permanently',
|
|
302 => 'Found',
|
|
303 => 'See Other',
|
|
304 => 'Not Modified',
|
|
305 => 'Use Proxy',
|
|
306 => '(Unused)',
|
|
307 => 'Temporary Redirect',
|
|
308 => 'Permanent Redirect',
|
|
//Client Error 4xx
|
|
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 Timeout',
|
|
409 => 'Conflict',
|
|
410 => 'Gone',
|
|
411 => 'Length Required',
|
|
412 => 'Precondition Failed',
|
|
413 => 'Request Entity Too Large',
|
|
414 => 'Request-URI Too Long',
|
|
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',
|
|
426 => 'Upgrade Required',
|
|
428 => 'Precondition Required',
|
|
429 => 'Too Many Requests',
|
|
431 => 'Request Header Fields Too Large',
|
|
//Server Error 5xx
|
|
500 => 'Internal Server Error',
|
|
501 => 'Not Implemented',
|
|
502 => 'Bad Gateway',
|
|
503 => 'Service Unavailable',
|
|
504 => 'Gateway Timeout',
|
|
505 => 'HTTP Version Not Supported',
|
|
506 => 'Variant Also Negotiates',
|
|
507 => 'Insufficient Storage',
|
|
508 => 'Loop Detected',
|
|
510 => 'Not Extended',
|
|
511 => 'Network Authentication Required',
|
|
];
|
|
|
|
/**
|
|
* Create new HTTP response.
|
|
*
|
|
* @param int $status The response status code.
|
|
* @param HeadersInterface|null $headers The response headers.
|
|
* @param StreamInterface|null $body The response body.
|
|
*/
|
|
public function __construct($status = 200, HeadersInterface $headers = null, StreamInterface $body = null)
|
|
{
|
|
$this->status = $this->filterStatus($status);
|
|
$this->headers = $headers ? $headers : new Headers();
|
|
$this->body = $body ? $body : new Body(fopen('php://temp', 'r+'));
|
|
}
|
|
|
|
/**
|
|
* This method is applied to the cloned object
|
|
* after PHP performs an initial shallow-copy. This
|
|
* method completes a deep-copy by creating new objects
|
|
* for the cloned object's internal reference pointers.
|
|
*/
|
|
public function __clone()
|
|
{
|
|
$this->headers = clone $this->headers;
|
|
$this->body = clone $this->body;
|
|
}
|
|
|
|
/*******************************************************************************
|
|
* Status
|
|
******************************************************************************/
|
|
|
|
/**
|
|
* Gets the response status code.
|
|
*
|
|
* The status code is a 3-digit integer result code of the server's attempt
|
|
* to understand and satisfy the request.
|
|
*
|
|
* @return int Status code.
|
|
*/
|
|
public function getStatusCode()
|
|
{
|
|
return $this->status;
|
|
}
|
|
|
|
/**
|
|
* Return an instance with the specified status code and, optionally, reason phrase.
|
|
*
|
|
* If no reason phrase is specified, implementations MAY choose to default
|
|
* to the RFC 7231 or IANA recommended reason phrase for the response's
|
|
* status code.
|
|
*
|
|
* This method MUST be implemented in such a way as to retain the
|
|
* immutability of the message, and MUST return an instance that has the
|
|
* updated status and reason phrase.
|
|
*
|
|
* @link http://tools.ietf.org/html/rfc7231#section-6
|
|
* @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
|
|
* @param int $code The 3-digit integer result code to set.
|
|
* @param string $reasonPhrase The reason phrase to use with the
|
|
* provided status code; if none is provided, implementations MAY
|
|
* use the defaults as suggested in the HTTP specification.
|
|
* @return self
|
|
* @throws \InvalidArgumentException For invalid status code arguments.
|
|
*/
|
|
public function withStatus($code, $reasonPhrase = '')
|
|
{
|
|
$code = $this->filterStatus($code);
|
|
|
|
if (!is_string($reasonPhrase) && !method_exists($reasonPhrase, '__toString')) {
|
|
throw new InvalidArgumentException('ReasonPhrase must be a string');
|
|
}
|
|
|
|
$clone = clone $this;
|
|
$clone->status = $code;
|
|
if ($reasonPhrase === '' && isset(static::$messages[$code])) {
|
|
$reasonPhrase = static::$messages[$code];
|
|
}
|
|
|
|
if ($reasonPhrase === '') {
|
|
throw new InvalidArgumentException('ReasonPhrase must be supplied for this code');
|
|
}
|
|
|
|
$clone->reasonPhrase = $reasonPhrase;
|
|
|
|
return $clone;
|
|
}
|
|
|
|
/**
|
|
* Filter HTTP status code.
|
|
*
|
|
* @param int $status HTTP status code.
|
|
* @return int
|
|
* @throws \InvalidArgumentException If an invalid HTTP status code is provided.
|
|
*/
|
|
protected function filterStatus($status)
|
|
{
|
|
if (!is_integer($status) || $status<100 || $status>599) {
|
|
throw new InvalidArgumentException('Invalid HTTP status code');
|
|
}
|
|
|
|
return $status;
|
|
}
|
|
|
|
/**
|
|
* Gets the response reason phrase associated with the status code.
|
|
*
|
|
* Because a reason phrase is not a required element in a response
|
|
* status line, the reason phrase value MAY be null. Implementations MAY
|
|
* choose to return the default RFC 7231 recommended reason phrase (or those
|
|
* listed in the IANA HTTP Status Code Registry) for the response's
|
|
* status code.
|
|
*
|
|
* @link http://tools.ietf.org/html/rfc7231#section-6
|
|
* @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
|
|
* @return string Reason phrase; must return an empty string if none present.
|
|
*/
|
|
public function getReasonPhrase()
|
|
{
|
|
if ($this->reasonPhrase) {
|
|
return $this->reasonPhrase;
|
|
}
|
|
if (isset(static::$messages[$this->status])) {
|
|
return static::$messages[$this->status];
|
|
}
|
|
return '';
|
|
}
|
|
|
|
/*******************************************************************************
|
|
* Body
|
|
******************************************************************************/
|
|
|
|
/**
|
|
* Write data to the response body.
|
|
*
|
|
* Note: This method is not part of the PSR-7 standard.
|
|
*
|
|
* Proxies to the underlying stream and writes the provided data to it.
|
|
*
|
|
* @param string $data
|
|
* @return self
|
|
*/
|
|
public function write($data)
|
|
{
|
|
$this->getBody()->write($data);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/*******************************************************************************
|
|
* Response Helpers
|
|
******************************************************************************/
|
|
|
|
/**
|
|
* Redirect.
|
|
*
|
|
* Note: This method is not part of the PSR-7 standard.
|
|
*
|
|
* This method prepares the response object to return an HTTP Redirect
|
|
* response to the client.
|
|
*
|
|
* @param string|UriInterface $url The redirect destination.
|
|
* @param int $status The redirect HTTP status code.
|
|
* @return self
|
|
*/
|
|
public function withRedirect($url, $status = 302)
|
|
{
|
|
return $this->withStatus($status)->withHeader('Location', (string)$url);
|
|
}
|
|
|
|
/**
|
|
* Json.
|
|
*
|
|
* Note: This method is not part of the PSR-7 standard.
|
|
*
|
|
* This method prepares the response object to return an HTTP Json
|
|
* response to the client.
|
|
*
|
|
* @param mixed $data The data
|
|
* @param int $status The HTTP status code.
|
|
* @param int $encodingOptions Json encoding options
|
|
* @return self
|
|
*/
|
|
public function withJson($data, $status = 200, $encodingOptions = 0)
|
|
{
|
|
$body = $this->getBody();
|
|
$body->rewind();
|
|
$body->write(json_encode($data, $encodingOptions));
|
|
|
|
return $this->withStatus($status)->withHeader('Content-Type', 'application/json;charset=utf-8');
|
|
}
|
|
|
|
/**
|
|
* Is this response empty?
|
|
*
|
|
* Note: This method is not part of the PSR-7 standard.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isEmpty()
|
|
{
|
|
return in_array($this->getStatusCode(), [204, 205, 304]);
|
|
}
|
|
|
|
/**
|
|
* Is this response informational?
|
|
*
|
|
* Note: This method is not part of the PSR-7 standard.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isInformational()
|
|
{
|
|
return $this->getStatusCode() >= 100 && $this->getStatusCode() < 200;
|
|
}
|
|
|
|
/**
|
|
* Is this response OK?
|
|
*
|
|
* Note: This method is not part of the PSR-7 standard.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isOk()
|
|
{
|
|
return $this->getStatusCode() === 200;
|
|
}
|
|
|
|
/**
|
|
* Is this response successful?
|
|
*
|
|
* Note: This method is not part of the PSR-7 standard.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isSuccessful()
|
|
{
|
|
return $this->getStatusCode() >= 200 && $this->getStatusCode() < 300;
|
|
}
|
|
|
|
/**
|
|
* Is this response a redirect?
|
|
*
|
|
* Note: This method is not part of the PSR-7 standard.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isRedirect()
|
|
{
|
|
return in_array($this->getStatusCode(), [301, 302, 303, 307]);
|
|
}
|
|
|
|
/**
|
|
* Is this response a redirection?
|
|
*
|
|
* Note: This method is not part of the PSR-7 standard.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isRedirection()
|
|
{
|
|
return $this->getStatusCode() >= 300 && $this->getStatusCode() < 400;
|
|
}
|
|
|
|
/**
|
|
* Is this response forbidden?
|
|
*
|
|
* Note: This method is not part of the PSR-7 standard.
|
|
*
|
|
* @return bool
|
|
* @api
|
|
*/
|
|
public function isForbidden()
|
|
{
|
|
return $this->getStatusCode() === 403;
|
|
}
|
|
|
|
/**
|
|
* Is this response not Found?
|
|
*
|
|
* Note: This method is not part of the PSR-7 standard.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isNotFound()
|
|
{
|
|
return $this->getStatusCode() === 404;
|
|
}
|
|
|
|
/**
|
|
* Is this response a client error?
|
|
*
|
|
* Note: This method is not part of the PSR-7 standard.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isClientError()
|
|
{
|
|
return $this->getStatusCode() >= 400 && $this->getStatusCode() < 500;
|
|
}
|
|
|
|
/**
|
|
* Is this response a server error?
|
|
*
|
|
* Note: This method is not part of the PSR-7 standard.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isServerError()
|
|
{
|
|
return $this->getStatusCode() >= 500 && $this->getStatusCode() < 600;
|
|
}
|
|
|
|
/**
|
|
* Convert response to string.
|
|
*
|
|
* Note: This method is not part of the PSR-7 standard.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function __toString()
|
|
{
|
|
$output = sprintf(
|
|
'HTTP/%s %s %s',
|
|
$this->getProtocolVersion(),
|
|
$this->getStatusCode(),
|
|
$this->getReasonPhrase()
|
|
);
|
|
$output .= PHP_EOL;
|
|
foreach ($this->getHeaders() as $name => $values) {
|
|
$output .= sprintf('%s: %s', $name, $this->getHeaderLine($name)) . PHP_EOL;
|
|
}
|
|
$output .= PHP_EOL;
|
|
$output .= (string)$this->getBody();
|
|
|
|
return $output;
|
|
}
|
|
}
|