symfony/src/Symfony/Component/RateLimiter

Rate Limiter Component

The Rate Limiter component provides a Token Bucket implementation to rate limit input and output in your application.

This Component is experimental. Experimental features are not covered by Symfony's Backward Compatibility Promise.

Getting Started

$ composer require symfony/rate-limiter

use Symfony\Component\RateLimiter\Storage\InMemoryStorage;
use Symfony\Component\RateLimiter\RateLimiter;

$limiter = new RateLimiter([
    'id' => 'login',
    'strategy' => 'token_bucket', // or 'fixed_window'
    'limit' => 10,
    'rate' => ['interval' => '15 minutes'],
], new InMemoryStorage());

// blocks until 1 token is free to use for this process
$limiter->reserve(1)->wait();
// ... execute the code

// only claims 1 token if it's free at this moment (useful if you plan to skip this process)
if ($limiter->consume(1)->isAccepted()) {
   // ... execute the code
}

Resources

• Contributing
• Report issues and send Pull Requests in the main Symfony repository