Interface 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 方法

返回允许的最大请求数和窗口大小.

public abstract array getRateLimit ( $request, $action )
$request yii\web\Request

当前请求.

$action yii\base\Action

要执行的动作.

return array

两个元素组成的数组. 第一个元素是允许的最大请求数, 第二个元素是窗口的大小(秒).

loadAllowance() public abstract 方法

从持久性存储中加载允许的请求数和相应的时间戳.

public abstract array loadAllowance ( $request, $action )
$request yii\web\Request

当前请求.

$action yii\base\Action

要执行的动作.

return array

两个元素组成的数组. 第一个元素是允许的请求数, 第二个元素是相应的 UNIX 时间戳.

saveAllowance() public abstract 方法

将允许的请求数和相应的时间戳保存到永久存储器.

public abstract void saveAllowance ( $request, $action, $allowance, $timestamp )
$request yii\web\Request

当前请求.

$action yii\base\Action

要执行的动作.

$allowance integer

剩余的允许请求数.

$timestamp integer

当前时间戳.