Class yii\web\TooManyRequestsHttpException
Inheritance | yii\web\TooManyRequestsHttpException » 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/TooManyRequestsHttpException.php |
TooManyRequestsHttpException represents a "Too Many Requests" HTTP exception with status code 429.
Use this exception to indicate that a client has made too many requests in a given period of time. For example, you would throw this exception when 'throttling' an API user.
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$statusCode | integer | HTTP status code, such as 403, 404, 500, etc. | yii\web\HttpException |
Public Methods
Method | Description | Defined By |
---|---|---|
__construct() | Constructor. | yii\web\TooManyRequestsHttpException |
getName() | yii\web\HttpException |
Method Details
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. |
public function __construct($message = null, $code = 0, $previous = null)
{
parent::__construct(429, $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';
}
Signup or Login in order to comment.