Download the PHP package beyondcode/laravel-fixed-window-limiter without Composer

On this page you can find all versions of the php package beyondcode/laravel-fixed-window-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 beyondcode/laravel-fixed-window-limiter

Informations about the package laravel-fixed-window-limiter

Fixed Time Window Rate Limiter for Laravel

Latest Version on Packagist Build Status Quality Score Total Downloads

This package allows you to easily create and validate rate limiting using the fixed window algorithm.

This package makes use of Redis' atomic requests.

Installation

You can install the package via composer:

Usage

You can create a new limiter instance by calling the create method and pass it a CarbonInterval that represents the window of time, that will be used for the limiter. The second argument is the maximum number of requests/attempts that your limiter will accept in that given time frame.

Running attempts against your limiter

Once your limiter is created, you can perform attempts against it to see if the call is within the usage limits that you specified. Since your limiter can be used for multiple resources, you need to pass the resource that you want to attempt the call for in the attempt method call.

Getting the usage count

When you want to read the number of attempts that were made for a given resource, you may call the getUsage method.

Note: This method will not return the number of attempts, but only the number of successful attempts. Use the getRealUsage method, if you want to see all attempts, including those that were rejected.

Or as mentioned, to get the real usage of all attempts for the resource:

Reset the limiter

If you want to reset the attempts for a specific resource, you may call the reset method on the limiter instance. This will reset the TTL to the given time frame and re-allow new attempts.

Additional data

Sometimes you might want to store additional data inside of the resource hash in Redis. You can pass the initial data to the reset method.

In order to retrieve the data, you may use the getAdditionalData method.

Testing

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

All versions of laravel-fixed-window-limiter with dependencies

PHP Build Version
Package Version
Requires php Version ^7.3
nesbot/carbon Version ^2.0
illuminate/support Version 5.8.*|^6.0
illuminate/redis Version 5.8.*|^6.0
predis/predis Version ^1.1
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 beyondcode/laravel-fixed-window-limiter contains the following files

Loading the files please wait ....