Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/razonyang/yii2-rate-limiter
Yii2 Rate Limiter
https://github.com/razonyang/yii2-rate-limiter
Last synced: 4 days ago
JSON representation
Yii2 Rate Limiter
- Host: GitHub
- URL: https://github.com/razonyang/yii2-rate-limiter
- Owner: razonyang
- License: bsd-3-clause
- Created: 2019-08-16T08:25:41.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2019-08-21T04:50:41.000Z (about 5 years ago)
- Last Synced: 2024-04-14T02:23:41.209Z (7 months ago)
- Language: PHP
- Size: 9.77 KB
- Stars: 9
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Yii2 Rate Limiter
=================
[](https://travis-ci.org/razonyang/yii2-rate-limiter)
[](https://scrutinizer-ci.com/g/razonyang/yii2-rate-limiter/?branch=master)
[](https://scrutinizer-ci.com/g/razonyang/yii2-rate-limiter/?branch=master)
[](https://packagist.org/packages/razonyang/yii2-rate-limiter)
[](https://packagist.org/packages/razonyang/yii2-rate-limiter)
[](LICENSE)
Backends
--------
- `Memcached` requires [memcached](https://www.php.net/manual/en/book.memcached.php) extension.
- `Redis` requires [redis](https://github.com/phpredis/phpredis) extension or [yiisoft/yii2-redis](https://github.com/yiisoft/yii2-redis) package.
Installation
------------
```
composer require razonyang/yii2-rate-limiter
```
Usage
-----
Let's take 5000 requests every hours as example:
```php
return [
public function behaviors()
{
return [
// redis via redis extension
'rateLimiter' => [
'class' => \RazonYang\Yii2\RateLimiter\RedisRateLimiter::class,
'password' => '',
'hostname' => 'localhost',
'port' => 6379,
'capacity' => 5000,
'rate' => 0.72,
'limitPeriod' => 3600,
'prefix' => 'rate_limiter:',
'ttl' => 3600,
// 'nameCallback' => $callback,
],
// redis via yii2-redis
'rateLimiter' => [
'class' => \RazonYang\Yii2\RateLimiter\Redis\RateLimiter::class,
'redis' => 'redis', // redis component name or definition
'capacity' => 5000,
'rate' => 0.72,
'limitPeriod' => 3600,
'prefix' => 'rate_limiter:',
'ttl' => 3600,
// 'nameCallback' => $callback,
],
// memcached
'rateLimiter' => [
'class' => \RazonYang\Yii2\RateLimiter\MemcachedRateLimiter::class,
'hostname' => 'localhost',
'port' => 11211,
'capacity' => 5000,
'rate' => 0.72,
'limitPeriod' => 3600,
'prefix' => 'rate_limiter:',
'ttl' => 3600,
// 'nameCallback' => $callback,
],
];
}
];
```
`RateLimiter` takes `uid:route`(authorized) or `ip:route`(guest) as bucket name, you can also change this behavior via `nameCallback`:
```php
$nameCallback = function (
\yii\web\User $user,
\yii\web\Request $request,
\yii\base\Action $action
): string {
return 'bucket name';
}
```