You are here

Home » API reference » RESTful 7 » RestfulRateLimitInterface.php

interface RestfulRateLimitInterface in RESTful 7

@file Contains RestfulRateLimitInterface.

Hierarchy

Expanded class hierarchy of RestfulRateLimitInterface

All classes that implement RestfulRateLimitInterface

File

plugins/rate_limit/RestfulRateLimitInterface.php, line 8
Contains RestfulRateLimitInterface.

View source 
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());

}

Members

Namesort descending Modifiers Type Description Overrides
RestfulRateLimitInterface::isRequestedEvent public function Checks if the current request meets the event for the implementing class. 2