Download the PHP package tal7aouy/api-rate-limiter without Composer

On this page you can find all versions of the php package tal7aouy/api-rate-limiter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of tal7aouy/api-rate-limiter

Informations about the package api-rate-limiter

API Rate Limiting Library

This library provides rate limiting functionality for PHP applications, using Redis for storage. It supports multiple rate limiting strategies and can be integrated with PSR-15 middleware.

Installation

To use the library, you need to have the following Composer packages, which are already included in the library's composer.json file:

  1. predis/predis - A Redis client library.
  2. laminas/laminas-diactoros - Provides PSR-7 (HTTP message) and PSR-15 (HTTP server) implementations.
  3. psr/http-server-handler - Provides the RequestHandlerInterface for handling HTTP requests.
  4. psr/http-server-middleware - Provides the MiddlewareInterface for HTTP middleware.
  5. laminas/laminas-httphandlerrunner - Provides the SapiEmitter class for emitting HTTP responses.

In addition, for development and testing, the library includes:

  1. phpstan/phpstan - For static analysis.
  2. pestphp/pest - For testing.

Install Library and Dependencies

Run the following Composer command to install all required packages:

Ensure Redis is installed and running on your system.

Usage

Basic Setup

  1. Initialize Redis Connection:

    Create a RedisConnection instance to handle the connection to the Redis server.

  2. Initialize Redis Rate Limiter:

    Create a RedisRateLimiter instance using the Redis connection.

  3. Initialize Rate Limiter Middleware:

    Create a RateLimiterMiddleware instance with the desired rate limit and time window.

  4. Create a Request Handler:

    Implement a simple request handler to handle incoming requests.

  5. Create Server Request and Process Through Middleware:

    Create a server request and process it through the rate limiter middleware.

Advanced Configuration

Custom Redis Configuration

You can configure the Redis connection by passing a custom configuration array to the RedisConnection class.

Custom Rate Limiting Strategies

The library supports multiple rate limiting strategies. You can implement your own strategy by extending the RateLimiter interface.

Then use the custom rate limiter with the middleware.

Testing

Unit tests are provided for each rate limiting strategy and Redis integration. To run the tests, use PestPHP.

Documentation

For detailed documentation and examples, please refer to the source code and comments within the library.

In the examples/index.php file, you can see a complete example of how to use the library.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request.

License

This software licensed under the MIT license.

All versions of api-rate-limiter with dependencies

PHP Build Version
Package Version
Requires php Version ^8.0
predis/predis Version ^2.2
laminas/laminas-diactoros Version ^3.3
psr/http-server-handler Version ^1.0
psr/http-server-middleware Version ^1.0
laminas/laminas-httphandlerrunner Version ^2.10
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package tal7aouy/api-rate-limiter contains the following files

Loading the files please wait ....