Stars: 204
Forks: 9
Pull Requests: 1
Issues: 0
Watchers: 8
Last Updated: 2023-07-30 09:09:35
Provides a Token Bucket implementation to rate limit input and output in your application
License: MIT License
Languages: PHP
The Rate Limiter component provides a Token Bucket implementation to rate limit input and output in your application.
$ composer require symfony/rate-limiter
use Symfony\Component\RateLimiter\Storage\InMemoryStorage;
use Symfony\Component\RateLimiter\RateLimiterFactory;
$factory = new RateLimiterFactory([
'id' => 'login',
'policy' => 'token_bucket',
'limit' => 10,
'rate' => ['interval' => '15 minutes'],
], new InMemoryStorage());
$limiter = $factory->create();
// 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
}