Class yii\web\HttpException

Inheritanceyii\web\HttpException » yii\base\UserException » yii\base\Exception » Exception
Subclassesyii\web\BadRequestHttpException, yii\web\ConflictHttpException, yii\web\ForbiddenHttpException, yii\web\GoneHttpException, yii\web\MethodNotAllowedHttpException, yii\web\NotAcceptableHttpException, yii\web\NotFoundHttpException, yii\web\RangeNotSatisfiableHttpException, yii\web\ServerErrorHttpException, yii\web\TooManyRequestsHttpException, yii\web\UnauthorizedHttpException, yii\web\UnprocessableEntityHttpException, yii\web\UnsupportedMediaTypeHttpException
Available since version2.0
Source Code

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.');

Public Properties

Hide inherited properties

Property Type Description Defined By
$statusCode integer HTTP status code, such as 403, 404, 500, etc. yii\web\HttpException

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Constructor. yii\web\HttpException
getName() yii\web\HttpException

Property Details

Hide inherited properties

$statusCode public property

HTTP status code, such as 403, 404, 500, etc.

public integer $statusCode null

Method Details

Hide inherited methods

__construct() public method


public void __construct ( $status, $message null, $code 0, $previous null )
$status integer

HTTP status code, such as 404, 500, etc.

$message string|null

Error message

$code integer

Error code

$previous Throwable|null

The previous exception used for the exception chaining.

                public function __construct($status, $message = null, $code = 0, $previous = null)
    $this->statusCode = $status;
    parent::__construct((string)$message, $code, $previous);

getName() public method

public string getName ( )
return string

The user-friendly name of this exception

                public function getName()
    if (isset(Response::$httpStatuses[$this->statusCode])) {
        return Response::$httpStatuses[$this->statusCode];
    return 'Error';