Interface yii\filters\RateLimitInterface

所有类 | 方法

可用版本自	2.0
源码	https://github.com/yiichina/yii2/blob/api/framework/filters/RateLimitInterface.php

RateLimitInterface 是可由标识对象实现以实施速率限制的接口。

公共方法

隐藏继承的方法

方法	描述	被定义在
getRateLimit()	返回允许的最大请求数和窗口大小。	yii\filters\RateLimitInterface
loadAllowance()	从持久存储加载允许的请求数和相应的时间戳。	yii\filters\RateLimitInterface
saveAllowance()	将允许的请求数和相应的时间戳保存到持久存储中。	yii\filters\RateLimitInterface

方法详情

getRateLimit() 公共抽象方法

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

public abstract array getRateLimit($request, $action)
$request	yii\web\Request	当前请求
$action	yii\base\Action	要执行的操作
return	array	由两个元素组成的数组。第一个元素是允许的最大请求数，第二个元素是以秒为单位的窗口大小。

loadAllowance() 公共抽象方法

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

public abstract array loadAllowance($request, $action)
$request	yii\web\Request	当前请求
$action	yii\base\Action	要执行的操作
return	array	由两个元素组成的数组。第一个元素是允许的请求数，第二个元素是相应的 UNIX 时间戳。

saveAllowance() 公共抽象方法

将允许的请求数和相应的时间戳保存到持久存储中。

public abstract void saveAllowance($request, $action, $allowance, $timestamp)
$request	yii\web\Request	当前请求
$action	yii\base\Action	要执行的操作
$allowance	integer	允许的剩余请求数。
$timestamp	integer	当前时间戳。