Inheritance | yii\web\ForbiddenHttpException » yii\web\HttpException » yii\base\UserException » yii\base\Exception » Exception |
---|---|
Available since version | 2.0 |
Source Code | https://github.com/yiisoft/yii2/blob/master/framework/web/ForbiddenHttpException.php |
ForbiddenHttpException represents a "Forbidden" HTTP exception with status code 403.
Use this exception when a user is not allowed to perform the requested action. Using different credentials might or might not allow performing the requested action. If you do not want to expose authorization information to the user, it is valid to respond with a 404 yii\web\NotFoundHttpException.
Property | Type | Description | Defined By |
---|---|---|---|
$statusCode | integer | HTTP status code, such as 403, 404, 500, etc. | yii\web\HttpException |
Method | Description | Defined By |
---|---|---|
__construct() | Constructor. | yii\web\ForbiddenHttpException |
getName() | yii\web\HttpException |
Constructor.
public function __construct($message = null, $code = 0, $previous = null)
{
parent::__construct(403, $message, $code, $previous);
}
Defined in: yii\web\HttpException::getName()
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';
}