class Unlimited extends GlobalLimit (View source)

Properties

mixed|string $key The rate limit signature key. from  Limit
int $maxAttempts The maximum number of attempts allowed within the given number of minutes. from  Limit
int $decayMinutes The number of minutes until the rate limit is reset. from  Limit
callable $responseCallback The response generator callback. from  Limit

Methods

void
__construct()

Create a new limit instance.

static Limit
perMinute(int $maxAttempts)

Create a new rate limit.

from  Limit
static Limit
perHour(int $maxAttempts, int $decayHours = 1)

Create a new rate limit using hours as decay time.

from  Limit
static Limit
perDay(int $maxAttempts, int $decayDays = 1)

Create a new rate limit using days as decay time.

from  Limit
static Limit
none()

Create a new unlimited rate limit.

from  Limit
$this
by(string $key)

Set the key of the rate limit.

from  Limit
$this
response(callable $callback)

Set the callback that should generate the response when the limit is exceeded.

from  Limit

Details

void __construct()

Create a new limit instance.

Return Value

void

static Limit perMinute(int $maxAttempts)

Create a new rate limit.

Parameters

int $maxAttempts

Return Value

Limit

static Limit perHour(int $maxAttempts, int $decayHours = 1)

Create a new rate limit using hours as decay time.

Parameters

int $maxAttempts
int $decayHours

Return Value

Limit

static Limit perDay(int $maxAttempts, int $decayDays = 1)

Create a new rate limit using days as decay time.

Parameters

int $maxAttempts
int $decayDays

Return Value

Limit

static Limit none()

Create a new unlimited rate limit.

Return Value

Limit

$this by(string $key)

Set the key of the rate limit.

Parameters

string $key

Return Value

$this

$this response(callable $callback)

Set the callback that should generate the response when the limit is exceeded.

Parameters

callable $callback

Return Value

$this