cyzonetech/rate-limit

Rate Limiting Library With Token Bucket Algorithm

1.3.1 2018-10-16 01:58 UTC

Requires

• php: >=5.5

Requires (Dev)

• phpunit/phpunit: ^4.6.6

Suggests

• ext-apc: ^4.0
• ext-apcu: ^4.0
• ext-redis: ^2.2

MIT

• touhonoob

README

RateLimit

PHP Rate Limiting Library With Token Bucket Algorithm

Storage Adapters

• APCu
• Redis

Example

require 'vendor/autoload.php';

use \Touhonoob\RateLimit\RateLimit;
use \Touhonoob\RateLimit\Adapter\APC as RateLimitAdapterAPC;
use \Touhonoob\RateLimit\Adapter\Redis as RateLimitAdapterRedis;

$adapter = new RateLimitAdapterAPC(); // Use APC as Storage
// $adapter = new RateLimitAdapterRedis(); // Use Redis as Storage
$rateLimit = new RateLimit("myratelimit", 100, 3600, $adapter); // 100 Requests / Hour

$id = $_SERVER['REMOTE_ADDR']; // Use client IP as identity
if ($rateLimit->check($id) > 0) {
  echo "passed";
} else {
  echo "rate limit exceeded";
}

Installing via Composer

curl -sS https://getcomposer.org/installer | php
composer.phar require touhonoob/rate-limit

References

• http://stackoverflow.com/a/668327/670662
• http://en.wikipedia.org/wiki/Token_bucket