PHPackages                             fyre/ratelimiter - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. fyre/ratelimiter

ActiveLibrary[Utility & Helpers](/categories/utility)

fyre/ratelimiter
================

A rate limiter library.

v5.0.8(10mo ago)0201MITPHP

Since Aug 18Pushed 10mo ago1 watchersCompare

[ Source](https://github.com/elusivecodes/FyreRateLimiter)[ Packagist](https://packagist.org/packages/fyre/ratelimiter)[ RSS](/packages/fyre-ratelimiter/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (7)Versions (17)Used By (1)

FyreRateLimiter
===============

[](#fyreratelimiter)

**FyreRateLimiter** is a free, open-source rate limiting library for *PHP*.

Table Of Contents
-----------------

[](#table-of-contents)

- [Installation](#installation)
- [Basic Usage](#basic-usage)
- [Methods](#methods)
- [Middleware](#middleware)

Installation
------------

[](#installation)

**Using Composer**

```
composer require fyre/ratelimiter

```

In PHP:

```
use Fyre\Security\RateLimiter;
```

Basic Usage
-----------

[](#basic-usage)

- `$container` is a [*Container*](https://github.com/elusivecodes/FyreContainer).
- `$cacheManager` is a [*CacheManager*](https://github.com/elusivecodes/FyreCache).
- `$options` is an array containing options for the *RateLimiter*.
    - `cacheConfig` is a string representing the configuration key for the [*Cache*](https://github.com/elusivecodes/FyreCache), and will default to "*ratelimiter*".
    - `limit` is a number representing the maximum number of requests that can be made within the period, and will default to *60*.
    - `period` is a number representing the number of seconds per rate limiting period, and will default to *60*.
    - `message` is a string representing the rate limit error message, and will default to "*Rate limit exceeded*".
    - `headers` is an array containing the rate limit headers.
        - `limit` is a string representing the rate limit header, and will default to "*X-RateLimit-Limit*".
        - `remaining` is a string representing the rate limit remaining header, and will default to "*X-RateLimit-Remaining*".
        - `reset` is a string representing the rate limit reset header, and will default to "*X-RateLimit-Reset*".
    - `identifier` is a *Closure* that accepts a [*ServerRequest*](https://github.com/elusivecodes/FyreServer#server-requests) as the first argument, and should return a string representing the client identifier.
    - `skipCheck` is a *Closure* that accepts a [*ServerRequest*](https://github.com/elusivecodes/FyreServer#server-requests) as the first argument, and can return *true* to skip rate limit checks for the request.
    - `errorRenderer` is a *Closure* that accepts a [*ServerRequest*](https://github.com/elusivecodes/FyreServer#server-requests) and a [*ClientResponse*](https://github.com/elusivecodes/FyreServer#client-responses) as the arguments, and should return a [*ClientResponse*](https://github.com/elusivecodes/FyreServer#client-responses).

```
$limiter = new RateLimiter($container, $cacheManager, $options);
```

If the `cacheConfig` doesn't exist in the [*CacheManager*](https://github.com/elusivecodes/FyreCache), a default [*FileCacher*](https://github.com/elusivecodes/FyreCache#file) will be created instead.

If the `identifier` callback is omitted, it will default to using the `$_SERVER['REMOTE_ADDR']`.

If the `errorRenderer` callback is omitted, it will default to negotiating a json or plaintext response containing the `message` option.

**Autoloading**

Any dependencies will be injected automatically when loading from the [*Container*](https://github.com/elusivecodes/FyreContainer).

```
$limiter = $container->use(RateLimiter::class, ['options' => $options]);
```

Methods
-------

[](#methods)

**Add Headers**

Add rate limit headers to a [*ClientResponse*](https://github.com/elusivecodes/FyreServer#client-responses).

- `$response` is a [*ClientResponse*](https://github.com/elusivecodes/FyreServer#client-responses).

```
$response = $limiter->addHeaders($response);
```

**Check Limit**

Determine whether the rate limit has been reached for a request.

- `$request` is the [*ServerRequest*](https://github.com/elusivecodes/FyreServer#server-requests).

```
$result = $limiter->checkLimit($request);
```

**Error Response**

Generate an error response.

- `$request` is the [*ServerRequest*](https://github.com/elusivecodes/FyreServer#server-requests).

```
$response = $limiter->errorResponse($request);
```

Middleware
----------

[](#middleware)

```
use Fyre\Security\Middleware\RateLimiterMiddleware;
```

- `$container` is a [*Container*](https://github.com/elusivecodes/FyreContainer).
- `$options` is an array containing options for the *RateLimiter*.
    - `cacheConfig` is a string representing the configuration key for the [*Cache*](https://github.com/elusivecodes/FyreCache), and will default to "*ratelimiter*".
    - `limit` is a number representing the maximum number of requests that can be made within the period, and will default to *60*.
    - `period` is a number representing the number of seconds per rate limiting period, and will default to *60*.
    - `message` is a string representing the rate limit error message, and will default to "*Rate limit exceeded*".
    - `headers` is an array containing the rate limit headers.
        - `limit` is a string representing the rate limit header, and will default to "*X-RateLimit-Limit*".
        - `remaining` is a string representing the rate limit remaining header, and will default to "*X-RateLimit-Remaining*".
        - `reset` is a string representing the rate limit reset header, and will default to "*X-RateLimit-Reset*".
    - `identifier` is a *Closure* that accepts a [*ServerRequest*](https://github.com/elusivecodes/FyreServer#server-requests) as the first argument, and should return a string representing the client identifier.
    - `skipCheck` is a *Closure* that accepts a [*ServerRequest*](https://github.com/elusivecodes/FyreServer#server-requests) as the first argument, and can return *true* to skip rate limit checks for the request.
    - `errorRenderer` is a *Closure* that accepts a [*ServerRequest*](https://github.com/elusivecodes/FyreServer#server-requests) and a [*ClientResponse*](https://github.com/elusivecodes/FyreServer#client-responses) as the arguments, and should return a [*ClientResponse*](https://github.com/elusivecodes/FyreServer#client-responses).

```
$middleware = new RateLimiterMiddleware($container, $options);
```

Any dependencies will be injected automatically when loading from the [*Container*](https://github.com/elusivecodes/FyreContainer).

```
$middleware = $container->build(RateLimiterMiddleware::class, ['options' => $options]);
```

**Handle**

Handle a [*ServerRequest*](https://github.com/elusivecodes/FyreServer#server-requests).

- `$request` is a [*ServerRequest*](https://github.com/elusivecodes/FyreServer#server-requests).
- `$next` is a *Closure*.

```
$response = $middleware->handle($request, $next);
```

This method will return a [*ClientResponse*](https://github.com/elusivecodes/FyreServer#client-responses).

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance54

Moderate activity, may be stable

Popularity6

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity48

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~21 days

Total

16

Last Release

311d ago

Major Versions

v1.0 → v2.02024-11-10

v2.0 → v3.02024-11-10

v3.0 → v4.02024-11-11

v4.0.3 → v5.02024-11-17

### Community

Maintainers

![](https://www.gravatar.com/avatar/fad81fd5941e3a637c8a5749d05ae3ed9314d5e2fee57f59c3d9ec3b41259c6b?d=identicon)[elusivecodes](/maintainers/elusivecodes)

---

Top Contributors

[![elusivecodes](https://avatars.githubusercontent.com/u/18050480?v=4)](https://github.com/elusivecodes "elusivecodes (16 commits)")

---

Tags

phprate-limiter

###  Code Quality

TestsPHPUnit

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/fyre-ratelimiter/health.svg)

```
[![Health](https://phpackages.com/badges/fyre-ratelimiter/health.svg)](https://phpackages.com/packages/fyre-ratelimiter)
```

###  Alternatives

[mediawiki/semantic-glossary

A terminology markup extension with a Semantic MediaWiki back-end

1352.4k](/packages/mediawiki-semantic-glossary)[thanks-to-it/wp-dich

121.1k](/packages/thanks-to-it-wp-dich)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)