Класс yii\filters\RateLimiter

RateLimiter реализует алгоритм ограничения скорости на основе алгоритма leaky bucket.

Вы можете использовать RateLimiter, подключив его как поведение к контроллеру или модулю, как показано ниже,

public function behaviors()
{
    return [
        'rateLimiter' => [
            'class' => \yii\filters\RateLimiter::className(),
        ],
    ];
}

Когда пользователь превысил лимит скорости, RateLimiter выбросит исключение yii\web\TooManyRequestsHttpException.

Обратите внимание, что RateLimiter требует, чтобы $user реализовывал интерфейс yii\filters\RateLimitInterface. RateLimiter ничего не сделает, если $user не задан или не реализует yii\filters\RateLimitInterface.

Публичные свойства

Публичные методы

Защищенные методы

Подробности свойств

$enableRateLimitHeaders публичное свойство

Включать ли заголовки ограничения скорости в ответ

public boolean $enableRateLimitHeaders = true

$errorMessage публичное свойство

Сообщение, отображаемое при превышении лимита скорости

public string $errorMessage = 'Rate limit exceeded.'

$request публичное свойство

Текущий запрос. Если не задан, будет использован компонент приложения request.

public yii\web\Request $request = null

$response публичное свойство

Ответ, который будет отправлен. Если не задан, будет использован компонент приложения response.

public yii\web\Response $response = null

$user публичное свойство

Объект пользователя, реализующий RateLimitInterface. Если не задан, будет взято значение из Yii::$app->user->getIdentity(false).

public yii\filters\RateLimitInterface $user = null

Подробности методов