beforeAction() public method This method is invoked right before an action is to be executed (after all possible filters.) You may override this method to do last-minute preparation for the action. public boolean beforeAction ( $action )$action yii\base\Action The action to be executed. return boolean Whether the action should continue to be executed.

addRateLimitHeaders() public method Adds the rate limit headers to the response public void addRateLimitHeaders ( $response, $limit, $remaining, $reset )$response yii\web\Response $limit integer The maximum number of allowed requests during a period $remaining integer The remaining number of allowed requests within the current period $reset integer The number of seconds to wait before having maximum number of allowed requests again

$user public property The user object that implements the RateLimitInterface. If not set, it will take the value of Yii::$app->user->getIdentity(false). public yii\filters\RateLimitInterface $user = null

$response public property The response to be sent. If not set, the response application component will be used. public yii\web\Response $response = null

$request public property The current request. If not set, the request application component will be used. public yii\web\Request $request = null

$errorMessage public property The message to be displayed when rate limit exceeds public string $errorMessage = 'Rate limit exceeded.'

$enableRateLimitHeaders public property Whether to include rate limit headers in the response public boolean $enableRateLimitHeaders = true

restoreResponse() protected method (available since version 2.0.3) Restores response properties from the given data protected void restoreResponse ( $response, $data )$response yii\web\Response The response to be restored $data array The response property data

init() public method Initializes the object. This method is invoked at the end of the constructor after the object is initialized with the given configuration. public void init ( )

calculateCacheKey() protected method (available since version 2.0.3) protected array calculateCacheKey ( )return array The key used to cache response properties.