sndsgd/rate

, _(*1)

Rate limiting for PHP., _(*2)

Requirements

This project is unstable and subject to changes from release to release., _(*3)

You need PHP >= 7.0 to use this library, however, the latest stable version of PHP is recommended., _(*4)

Install

Install sndsgd/rate using Composer., _(*5)

Usage

Note: At the moment, this library only contains rate limiting tools., _(*6)

# define the rate limits
$clientIp = $di->getClient()->getIp();
$limits = [
    new \sndsgd\rate\Limit("Search-PerSecond", $clientIp, 1, 3),
    new \sndsgd\rate\Limit("Search-PerHour", $clientIp, 600, 3600),
];

# create a limiter, and increment the hit counts for all limits
$redis = $di->getRedis();
$limiter = new \sndsgd\rate\limiter\RedisLimiter($redis, $limits);
$limiter->increment();

# copy the rate limit headers to the response
$response = $di->getResponse();
foreach ($limiter->getHeaders() as $header) {
    list($key, $value) = preg_split("/\:\s?/", $header, 2);
    $response->addHeader($key, $value);
}

# if the limit was exceeded, prevent futher execution
if ($limiter->isExceeded()) {
    throw new \sndsgd\http\exception\TooManyRequestsException();
}