0 フォロワー

インターフェース yii\filters\RateLimitInterface

利用可能なバージョン	2.0
ソースコード	https://github.com/yiisoft/yii2/blob/master/framework/filters/RateLimitInterface.php

RateLimitInterface は、レート制限を強制するためにアイデンティティオブジェクトによって実装される可能性のあるインターフェースです。

パブリックメソッド

メソッド	説明	定義元
getRateLimit()	許可される最大リクエスト数とウィンドウサイズを返します。	yii\filters\RateLimitInterface
loadAllowance()	永続ストレージから、許可されたリクエスト数と対応するタイムスタンプをロードします。	yii\filters\RateLimitInterface
saveAllowance()	許可されたリクエスト数と対応するタイムスタンプを永続ストレージに保存します。	yii\filters\RateLimitInterface

getRateLimit() public abstract method

許可される最大リクエスト数とウィンドウサイズを返します。

public abstract array getRateLimit ( $request, $action )
$request	yii\web\Request	現在のリクエスト
$action	yii\base\Action	実行されるアクション
return	array	2つの要素の配列。最初の要素は許可される最大リクエスト数、2番目の要素は秒単位のウィンドウサイズです。

                public function getRateLimit($request, $action);

loadAllowance() public abstract method

永続ストレージから、許可されたリクエスト数と対応するタイムスタンプをロードします。

public abstract array loadAllowance ( $request, $action )
$request	yii\web\Request	現在のリクエスト
$action	yii\base\Action	実行されるアクション
return	array	2つの要素の配列。最初の要素は許可されたリクエスト数、2番目の要素は対応するUNIXタイムスタンプです。

                public function loadAllowance($request, $action);

saveAllowance() public abstract method

許可されたリクエスト数と対応するタイムスタンプを永続ストレージに保存します。

public abstract void saveAllowance ( $request, $action, $allowance, $timestamp )
$request	yii\web\Request	現在のリクエスト
$action	yii\base\Action	実行されるアクション
$allowance	integer	残りの許可されたリクエスト数。
$timestamp	integer	現在のタイムスタンプ。

                public function saveAllowance($request, $action, $allowance, $timestamp);