RateLimitInterface

API reference › yii › filters › RateLimitInterface

interface	yii\filters\RateLimitInterface
Since	2.0
Source	framework/filters/RateLimitInterface.php

RateLimitInterface is the interface that may be implemented by an identity object to enforce rate limiting.

Methods

Method	Description	Defined by
getRateLimit() abstract	Returns the maximum number of allowed requests and the window size.	RateLimitInterface
loadAllowance() abstract	Loads the number of allowed requests and the corresponding timestamp from a persistent storage.	RateLimitInterface
saveAllowance() abstract	Saves the number of allowed requests and the corresponding timestamp to a persistent storage.	RateLimitInterface

Method details

getRateLimit()

abstract public function getRateLimit(yii\web\Request $request, yii\base\Action $action): array

Returns the maximum number of allowed requests and the window size.

Parameters

Parameter	Type	Description
$request	yii\web\Request	The current request
$action	yii\base\Action	The action to be executed

Returns

array: An array of two elements. The first element is the maximum number of allowed requests, and the second element is the size of the window in seconds.

loadAllowance()

abstract public function loadAllowance(yii\web\Request $request, yii\base\Action $action): array

Loads the number of allowed requests and the corresponding timestamp from a persistent storage.

Parameters

Parameter	Type	Description
$request	yii\web\Request	The current request
$action	yii\base\Action	The action to be executed

Returns

array: An array of two elements. The first element is the number of allowed requests, and the second element is the corresponding UNIX timestamp.

saveAllowance()

abstract public function saveAllowance(yii\web\Request $request, yii\base\Action $action, int $allowance, int $timestamp): mixed

Saves the number of allowed requests and the corresponding timestamp to a persistent storage.

Parameters

Parameter	Type	Description
$request	yii\web\Request	The current request
$action	yii\base\Action	The action to be executed
$allowance	int	The number of allowed requests remaining.
$timestamp	int	The current timestamp.

Returns

mixed