0 フォロワー

クラス yii\web\TooManyRequestsHttpException

全クラス | プロパティ | メソッド
継承yii\web\TooManyRequestsHttpException » yii\web\HttpException » yii\base\UserException » yii\base\Exception » Exception
利用可能バージョン2.0
ソースコード https://github.com/yiisoft/yii2/blob/master/framework/web/TooManyRequestsHttpException.php

TooManyRequestsHttpException は、ステータスコード 429 を持つ「Too Many Requests」HTTP 例外を表します。

クライアントが一定期間内に多くのリクエストを行ったことを示すために、この例外を使用します。たとえば、API ユーザーの「スロットリング」を行う場合に、この例外をスローします。

こちらも参照してください https://tools.ietf.org/html/rfc6585#section-4.

公開プロパティ

継承されたプロパティを非表示

プロパティ 型 説明 定義元
$statusCode integer HTTP ステータスコード (例: 403、404、500 など) yii\web\HttpException

公開メソッド

継承されたメソッドを非表示

メソッド 説明 定義元
__construct() コンストラクター。 yii\web\TooManyRequestsHttpException
getName() yii\web\HttpException

メソッドの詳細

継承されたメソッドを非表示

__construct() public メソッド

コンストラクター。

public void __construct ( $message = null, $code = 0, $previous = null )
$message string|null

エラーメッセージ
$code integer

エラーコード
$previous Throwable|null

例外チェーンに使用される前の例外。

 

                public function __construct($message = null, $code = 0, $previous = null)
{
    parent::__construct(429, $message, $code, $previous);
}
getName() public メソッド

定義済み: yii\web\HttpException::getName()

public string getName ( )
戻り値 string

この例外のユーザーフレンドリーな名前

 

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