silverstripe-framework/src/Control/HTTPResponse_Exception.php

71 lines
2.1 KiB
PHP
Raw Normal View History

<?php
namespace SilverStripe\Control;
use Exception;
/**
2016-09-09 08:43:05 +02:00
* A {@link HTTPResponse} encapsulated in an exception, which can interrupt the processing flow and be caught by the
* {@link RequestHandler} and returned to the user.
*
* Example Usage:
* <code>
2016-09-09 08:43:05 +02:00
* throw new HTTPResponse_Exception('This request was invalid.', 400);
* throw new HTTPResponse_Exception(new HTTPResponse('There was an internal server error.', 500));
* </code>
*/
2016-09-09 08:43:05 +02:00
class HTTPResponse_Exception extends Exception
{
2016-11-29 00:31:16 +01:00
protected $response;
2016-11-29 00:31:16 +01:00
/**
* @param HTTPResponse|string $body Either the plaintext content of the error
* message, or an HTTPResponse object representing it. In either case, the
* $statusCode and $statusDescription will be the HTTP status of the resulting
* response.
* @param int $statusCode
* @param string $statusDescription
* @see HTTPResponse::__construct();
*/
public function __construct($body = null, $statusCode = null, $statusDescription = null)
{
if ($body instanceof HTTPResponse) {
// statusCode and statusDescription should override whatever is passed in the body
if ($statusCode) {
$body->setStatusCode($statusCode);
}
if ($statusDescription) {
$body->setStatusDescription($statusDescription);
}
2016-11-29 00:31:16 +01:00
$this->setResponse($body);
} else {
$response = new HTTPResponse($body, $statusCode, $statusDescription);
2016-11-29 00:31:16 +01:00
// Error responses should always be considered plaintext, for security reasons
$response->addHeader('Content-Type', 'text/plain');
2016-11-29 00:31:16 +01:00
$this->setResponse($response);
}
2016-11-29 00:31:16 +01:00
parent::__construct($this->getResponse()->getBody(), $this->getResponse()->getStatusCode());
}
2016-11-29 00:31:16 +01:00
/**
* @return HTTPResponse
*/
public function getResponse()
{
return $this->response;
}
2016-11-29 00:31:16 +01:00
/**
* @param HTTPResponse $response
*/
public function setResponse(HTTPResponse $response)
{
$this->response = $response;
}
}