Download the PHP package oaklabs/phalcon-throttler without Composer
On this page you can find all versions of the php package oaklabs/phalcon-throttler. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download oaklabs/phalcon-throttler
More information about oaklabs/phalcon-throttler
Files in oaklabs/phalcon-throttler
Package phalcon-throttler
Short Description Rate limiter PHP Phalcon Framework.
License MIT
FAQ
Example:
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 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.
Informations about the package phalcon-throttler
Throttler
Introduction
Phalcon Throttler is a Rate Limiter for PHP Phalcon Framework.
It provides a simple interface to build Rate Limiters using various strategies as well as with a Redis Throttler ready out of the box.
PHP 7.1+ and Phalcon 3.1.2+ are required.
Installation
Throttler can be installed through Composer, just include "oaklabs/phalcon-throttler": "^0.1" to your composer.json and run composer update or composer install.
Usage
Throttling
Phalcon Throttler comes shipped with a Redis throttler by default. It uses PhpRedis to communicate with the Redis server.
First of all we need a Redis instance.
We can then add a redis service in the Phalcon Dependency Injection container
so that it can be used when we want to create an instance of the Redis Throttler. We can set it up in the Dependency Injection container as well
The second parameter allows to configure the behaviour of the Throttler:
- bucket_size: the number of allowed hits in the period of time of reference
- refill_time: the amount of time after that the counter will completely or partially reset
- refill_amount: the number of hits to be reset every time the refill_time passes
You are now able to successfully throttle users:
Strategies
The only question left is: which one is the appropriate place where the check should be performed?
There is of course not an uniquely valid answer, several places can be used.
Check in the dispatcher
A good strategy is to put the check during the Phalcon dispatcher lifecycle.
In the dependency injection we can use the Phalcon Event Manager to listen to the dispatcher event and bind it to some Security plugin
and put our Rate Limiter in it
and finally perform a redirection in case the User gets rate limited.
The information returned by the $rateLimit->toArray() method contains:
Contribution guidelines
Throttler follows PSR-1, PSR-2 and PSR-4 PHP coding standards, and semantic versioning.
Pull requests are welcome.
License
Throttler is free software distributed under the terms of the MIT license.
All versions of phalcon-throttler with dependencies
ext-phalcon Version >=3.1.2