W3cubDocs

/Laravel 8

Unlimited

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

Create a new limit instance.

static Limit

perMinute(int $maxAttempts)

Create a new rate limit.

static Limit

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

Create a new rate limit using hours as decay time.

static Limit

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

Create a new rate limit using days as decay time.

static Limit

none()

Create a new unlimited rate limit.

$this

by(string $key)

Set the key of the rate limit.

$this

response(callable $callback)

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

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

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

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

static Limit none()

Create a new unlimited rate limit.

Return Value

$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

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Cache/RateLimiting/Unlimited.html