Интерфейс 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 массив getRateLimit ( $request, $action ) | ||
|---|---|---|
| $request | yii\web\Request |
Текущий запрос |
| $action | yii\base\Action |
Действие, которое будет выполнено |
| return | массив |
Массив из двух элементов. Первый элемент — максимальное количество разрешенных запросов, второй — размер окна во секундах. |
loadAllowance() public abstract method
Загружает количество разрешенных запросов и соответствующую метку времени из постоянного хранилища.
| public abstract массив loadAllowance ( $request, $action ) | ||
|---|---|---|
| $request | yii\web\Request |
Текущий запрос |
| $action | yii\base\Action |
Действие, которое будет выполнено |
| return | массив |
Массив из двух элементов. Первый элемент — количество разрешенных запросов, второй — соответствующая метка времени в формате Unix. |
saveAllowance() public abstract method
Сохраняет количество разрешенных запросов и соответствующую метку времени в постоянном хранилище.
| public abstract void saveAllowance ( $request, $action, $allowance, $timestamp ) | ||
|---|---|---|
| $request | yii\web\Request |
Текущий запрос |
| $action | yii\base\Action |
Действие, которое будет выполнено |
| $allowance | целое число |
Остаток разрешенных запросов. |
| $timestamp | целое число |
Текущая метка времени. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-filters-ratelimitinterface.html
