This is an exception class that wraps a Response and extends HttpException. More...
Public Member Functions | |
| __construct (Response $response) | |
| getResponse () | |
 Public Member Functions inherited from MediaWiki\Rest\HttpException | |
| __construct ( $message, $code=500, $errorData=null) | |
| getErrorData () | |
Private Attributes | |
| Response | $response |
| The wrapped Response. | |
Detailed Description
This is an exception class that wraps a Response and extends HttpException.
It is used when a particular response type (whatever the HTTP status code) is treated as an exceptional output in your API, and you want to be able to throw it from wherever you are and immediately halt request processing. It can also be used to customize the standard 3xx or 4xx error Responses returned by the standard HttpException, for example to add custom headers.
@newable
- Since
- 1.36
Definition at line 17 of file ResponseException.php.
Constructor & Destructor Documentation
◆ __construct()
| MediaWiki\Rest\ResponseException::__construct | ( | Response | $response | ) |
- Stability: stable
- to call
- Parameters
-
Response $response The wrapped Response
Definition at line 30 of file ResponseException.php.
References MediaWiki\Rest\ResponseException\$response, and MediaWiki\Rest\Response\getStatusCode().
Member Function Documentation
◆ getResponse()
| MediaWiki\Rest\ResponseException::getResponse | ( | ) |
- Returns
- Response
Definition at line 38 of file ResponseException.php.
Member Data Documentation
◆ $response
|
private |
The wrapped Response.
Definition at line 23 of file ResponseException.php.
Referenced by MediaWiki\Rest\ResponseException\__construct().
The documentation for this class was generated from the following file:
- includes/Rest/ResponseException.php
