makm/flood-control

simple flood control for any actions

v0.0.2 2020-01-23 07:34 UTC

Requires (Dev)

• phpunit/phpunit: ^8.5

MIT

• Maxim Kapkaev

• php
• control
• flood
• anti

README

Install

composer install makm/flood-control

Configuration simple:

$redis  = new \Redis();
$redis->connect('localhost');
$provider = new \Makm\FloodControl\AttemptProvider($redis);
$floodControl = new \Makm\FloodControl\FloodControl(
$provider,
[
    ['period' => \Makm\FloodControl\Limitations::PERIOD_WEEK, 'amount' => 5, 'times' => 15, 'sms-code'],
    ['period' => \Makm\FloodControl\Limitations::PERIOD_WEEK, 'amount' => 3, 'times' => 3, 'mail'],
    ['period' => \Makm\FloodControl\Limitations::PERIOD_DAY, 'amount' => 3, 'times' => 10, 'sms-code'],
    ['period' => \Makm\FloodControl\Limitations::PERIOD_DAY, 'amount' => 1, 'times' => 2, 'mail'],
    ['period' => \Makm\FloodControl\Limitations::PERIOD_MONTH, 'amount' => 1, 'times' => 200, 'sms-code'],
]);

$result = $floodControl->doAttempt(new Action('sms-code', '[phone]'));

$result = $floodControl->allow(new Action('mail', '[phone]'));

Symfony:

  Makm\FloodControl\FloodControl:
    arguments:
      - '@Makm\FloodControl\AttemptProvider\RedisProvider'
      - [
          {period: minute, amount: 1, times: 1, group: confirm-phone }
          {period: hour, amount: 1, times: 5, group: confirm-phone }
          {period: day, amount: 1, times: 10, group: confirm-phone }
        ]