Class yii\web\UnauthorizedHttpException

All Classes | Properties | Methods

Inheritance	yii\web\UnauthorizedHttpException » 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/UnauthorizedHttpException.php

UnauthorizedHttpException represents an "Unauthorized" HTTP exception with status code 401.

Use this exception to indicate that a client needs to authenticate via WWW-Authenticate header to perform the requested action.

If the client is already authenticated and is simply not allowed to perform the action, consider using a 403 yii\web\ForbiddenHttpException or 404 yii\web\NotFoundHttpException instead.

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\UnauthorizedHttpException
getName()		yii\web\HttpException

Method Details

Hide inherited methods

__construct() public method

Constructor.

public void __construct ( $message = null, $code = 0, $previous = null )
$message	string\|null	Error message
$code	integer	Error code
$previous	Throwable\|null	The previous exception used for the exception chaining.

Source code

                public function __construct($message = null, $code = 0, $previous = null)
{
    parent::__construct(401, $message, $code, $previous);
}

getName() public method

Defined in: yii\web\HttpException::getName()

public string getName ( )
return	string	The user-friendly name of this exception

Source code

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