ForbiddenHttpException
API reference › yii › web › ForbiddenHttpException
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 NotFoundHttpException.
See also: https://tools.ietf.org/html/rfc7231#section-6.5.3.
Properties
Section titled “Properties”| Property | Type | Description | Defined by |
|---|---|---|---|
$statusCode | int | HTTP status code, such as 403, 404, 500, etc. Default: null. | HttpException |
Methods
Section titled “Methods”| Method | Description | Defined by |
|---|---|---|
__construct() | Constructor. | ForbiddenHttpException |
getName() | HttpException |
Method details
Section titled “Method details”__construct()
Section titled “__construct() ”public function __construct(string|null $message = null, int $code = 0, Throwable|null $previous = null)Constructor.
Parameters
| Parameter | Type | Description |
|---|---|---|
$message | string| | Error message |
$code | int | Error code |
$previous | Throwable| | The previous exception used for the exception chaining. |