Download the PHP package muffin/throttle without Composer
On this page you can find all versions of the php package muffin/throttle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
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 throttle
Throttle
(API) Rate limiting requests in CakePHP
This plugin allows you to limit the number of requests a client can make to your app in a given time frame.
Installation
To make your application load the plugin either run:
Configuration
In your config/app.php add a cache config named throttle under the Cache key
with required config. For e.g.:
Using the Middleware
Add the middleware to the queue and pass your custom configuration:
The above example would allow 100 requests/minute/token and would first try to identify the client by JWT Bearer token before falling back to (Throttle default) IP address based identification.
Events
The middleware also dispatches following event which effectively allows you to have multiple rate limits:
Throttle.beforeThrottle
This is the first event that is triggered before a request is processed by the middleware. All rate limiting process will be bypassed if this event is stopped.
Throttle.getIdentifier
Instead of using the indentifer config you can also setup a listener for the
Throttle.getIdentifier event. The event's callback would receive a request
instance as argument and must return an identifier string.
Throttle.getThrottleInfo
The Throttle.getThrottleInfo event allows you to customize the period and limit
configs for a request as well as the cache key used to store the rate limiting info.
This allows you to set multiple rate limit as per your app's needs.
Here's an example:
Throtttle.beforeCacheSet
The Throtttle.beforeCacheSet event allows you to observe result of middleware configuration and previous
Throtttle.getIdentifier and Throttle.getThrottleInfo events results.
You can also use this event to modify cached $rateLimit and $ttl values,
modifying $throttleInfo in this event has no effect.
Example:
X-headers
By default Throttle will add X-headers with rate limiting information to all responses:
To customize the header names simply pass (all of them) under headers key in
your configuration array:
To disable the headers set headers key to false.
Customize response object
You may use type and headers subkeys of the response array (as you would do
with a Response object) if you want to return a different message as the default one:
Patches & Features
- Fork
- Mod, fix
- Test - this is important, so it's not unintentionally broken
- Commit - do not mess with license, todo, version, etc. (if you do change any, bump them into commits of their own that I can ignore when I pull)
- Pull request - bonus point for topic branches
To ensure your PRs are considered for upstream, you MUST follow the CakePHP coding standards.
Bugs & Feedback
http://github.com/usemuffin/throttle/issues
License
Copyright (c) 2015-Present, [Use Muffin] and licensed under The MIT License.
