HttpException
extends UserException
in package
HttpException represents an exception caused by an improper request of the end-user.
HttpException can be differentiated via its [[statusCode]] property value which keeps a standard HTTP status code (e.g. 404, 500). Error handlers may use this status code to decide how to format the error page.
Throwing an HttpException like in the following example will result in the 404 page to be displayed.
if ($item === null) { // item does not exist
throw new \yii\web\HttpException(404, 'The requested Item could not be found.');
}
Tags
Table of Contents
Properties
- $statusCode : int
Methods
- __construct() : mixed
- Constructor.
- getName() : string
Properties
$statusCode
public
int
$statusCode
HTTP status code, such as 403, 404, 500, etc.
Methods
__construct()
Constructor.
public
__construct(int $status[, string|null $message = null ][, int $code = 0 ][, Throwable|null $previous = null ]) : mixed
Parameters
- $status : int
-
HTTP status code, such as 404, 500, etc.
- $message : string|null = null
-
error message
- $code : int = 0
-
error code
- $previous : Throwable|null = null
-
The previous exception used for the exception chaining.
getName()
public
getName() : string
Return values
string —the user-friendly name of this exception