You are here

RestfulRateLimitInterface.php in RESTful 7

Contains RestfulRateLimitInterface.

File

plugins/rate_limit/RestfulRateLimitInterface.php
View source
<?php

/**
 * @file
 * Contains RestfulRateLimitInterface.
 */
interface RestfulRateLimitInterface {

  /**
   * Checks if the current request meets the event for the implementing class.
   *
   * @param array $request
   *   (optional) The request array.
   *
   * @return boolean
   *   TRUE if the event is met and the rate limit hits counter should be
   *   incremented.
   */
  public function isRequestedEvent(array $request = array());

}

Interfaces

Namesort descending Description
RestfulRateLimitInterface @file Contains RestfulRateLimitInterface.