symfony / rate-limiter
Provides a Token Bucket implementation to rate limit input and output in your application
Fund package maintenance!
fabpot
Tidelift
symfony.com/sponsor
Requires
- php: >=7.2.5
- symfony/lock: ^5.2
- symfony/options-resolver: ^5.1
Requires (Dev)
- psr/cache: ^1.0|^2.0|^3.0
This package is auto-updated.
Last update: 2021-10-26 16:03:52 UTC
README
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\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 }