You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
76 lines
2.6 KiB
76 lines
2.6 KiB
<?php
|
|
/**
|
|
* CodeIgniter
|
|
*
|
|
* An open source application development framework for PHP
|
|
*
|
|
* This content is released under the MIT License (MIT)
|
|
*
|
|
* Copyright (c) 2014-2019 British Columbia Institute of Technology
|
|
* Copyright (c) 2019 CodeIgniter Foundation
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*
|
|
* @package CodeIgniter
|
|
* @author CodeIgniter Dev Team
|
|
* @copyright 2019 CodeIgniter Foundation
|
|
* @license https://opensource.org/licenses/MIT MIT License
|
|
* @link https://codeigniter.com
|
|
* @since Version 4.0.0
|
|
* @filesource
|
|
*/
|
|
|
|
namespace CodeIgniter\Throttle;
|
|
|
|
/**
|
|
* Expected behavior of a Throttler
|
|
*/
|
|
interface ThrottlerInterface
|
|
{
|
|
|
|
/**
|
|
* Restricts the number of requests made by a single key within
|
|
* a set number of seconds.
|
|
*
|
|
* Example:
|
|
*
|
|
* if (! $throttler->checkIPAddress($request->ipAddress(), 60, MINUTE))
|
|
* {
|
|
* die('You submitted over 60 requests within a minute.');
|
|
* }
|
|
*
|
|
* @param string $key The name to use as the "bucket" name.
|
|
* @param integer $capacity The number of requests the "bucket" can hold
|
|
* @param integer $seconds The time it takes the "bucket" to completely refill
|
|
* @param integer $cost The number of tokens this action uses.
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function check(string $key, int $capacity, int $seconds, int $cost);
|
|
|
|
//--------------------------------------------------------------------
|
|
|
|
/**
|
|
* Returns the number of seconds until the next available token will
|
|
* be released for usage.
|
|
*
|
|
* @return integer
|
|
*/
|
|
public function getTokenTime(): int;
|
|
}
|
|
|