1. class
  2. Hypervel
  3. \
  4. RateLimiter
  5. \
  6. Limit

Limit

class Limit extends AdmissionPolicy

Constants

MAX_INTEGER

The largest integer represented exactly by every first-party store.

Methods

__construct(int $maxAttempts = 60, int $decaySeconds = 60, string $key = '', int $cost = 1, bool $global = false, Closure|null $afterCallback = null, Closure|null $responseCallback = null)

Create a new fixed-window limit.

AdmissionPolicy
by(Stringable|UnitEnum|string|int|null $key)

Set the key of the rate limit.

from  AdmissionPolicy
AdmissionPolicy
cost(int $cost)

Set the capacity consumed by each operation.

from  AdmissionPolicy
AdmissionPolicy
globally(bool $global = true)

Apply the policy without a named limiter scope.

from  AdmissionPolicy
AdmissionPolicy
after(callable $callback)

Set the callback that determines whether the operation should be consumed.

from  AdmissionPolicy
AdmissionPolicy
response(callable $callback)

Set the callback that generates a response when the limit is exceeded.

from  AdmissionPolicy
AdmissionPolicy
newInstance(string $key, int $cost, bool $global, Closure|null $afterCallback, Closure|null $responseCallback)

Create a copy with the given shared policy values.

string
normalizeKey(Stringable|UnitEnum|string|int|null $key)

Convert a caller key to its canonical string value.

from  AdmissionPolicy
static void
ensurePositive(string $name, int $value)

Validate a positive shared integer.

from  AdmissionPolicy
static int
multiply(int $value, int $multiplier, string $name)

Multiply positive rate limit values without losing integer precision.

from  AdmissionPolicy
static Limit
perSecond(int $maxAttempts, int $decaySeconds = 1)

Create a new per-second rate limit.

static Limit
perMinute(int $maxAttempts, int $decayMinutes = 1)

Create a new per-minute rate limit.

static Limit
perMinutes(int $decayMinutes, int $maxAttempts)

Create a new rate limit using minutes as the decay time.

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

Create a new per-hour rate limit.

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

Create a new per-day rate limit.

static Unlimited
none()

Create a new unlimited rate limit.

Details

at line 14
__construct(int $maxAttempts = 60, int $decaySeconds = 60, string $key = '', int $cost = 1, bool $global = false, Closure|null $afterCallback = null, Closure|null $responseCallback = null)

Create a new fixed-window limit.

Parameters

int $maxAttempts
int $decaySeconds
string $key
int $cost
bool $global
Closure|null $afterCallback
Closure|null $responseCallback

in AdmissionPolicy at line 37
AdmissionPolicy by(Stringable|UnitEnum|string|int|null $key)

Set the key of the rate limit.

Parameters

Stringable|UnitEnum|string|int|null $key

Return Value

AdmissionPolicy

in AdmissionPolicy at line 51
AdmissionPolicy cost(int $cost)

Set the capacity consumed by each operation.

Parameters

int $cost

Return Value

AdmissionPolicy

in AdmissionPolicy at line 70
AdmissionPolicy globally(bool $global = true)

Apply the policy without a named limiter scope.

Parameters

bool $global

Return Value

AdmissionPolicy

in AdmissionPolicy at line 84
AdmissionPolicy after(callable $callback)

Set the callback that determines whether the operation should be consumed.

Parameters

callable $callback

Return Value

AdmissionPolicy

in AdmissionPolicy at line 98
AdmissionPolicy response(callable $callback)

Set the callback that generates a response when the limit is exceeded.

Parameters

callable $callback

Return Value

AdmissionPolicy

at line 87
protected AdmissionPolicy newInstance(string $key, int $cost, bool $global, Closure|null $afterCallback, Closure|null $responseCallback)

Create a copy with the given shared policy values.

Parameters

string $key
int $cost
bool $global
Closure|null $afterCallback
Closure|null $responseCallback

Return Value

AdmissionPolicy

in AdmissionPolicy at line 123
protected string normalizeKey(Stringable|UnitEnum|string|int|null $key)

Convert a caller key to its canonical string value.

Parameters

Stringable|UnitEnum|string|int|null $key

Return Value

string

in AdmissionPolicy at line 135
static protected void ensurePositive(string $name, int $value)

Validate a positive shared integer.

Parameters

string $name
int $value

Return Value

void

in AdmissionPolicy at line 149
static protected int multiply(int $value, int $multiplier, string $name)

Multiply positive rate limit values without losing integer precision.

Parameters

int $value
int $multiplier
string $name

Return Value

int

at line 33
static Limit perSecond(int $maxAttempts, int $decaySeconds = 1)

Create a new per-second rate limit.

Parameters

int $maxAttempts
int $decaySeconds

Return Value

Limit

at line 41
static Limit perMinute(int $maxAttempts, int $decayMinutes = 1)

Create a new per-minute rate limit.

Parameters

int $maxAttempts
int $decayMinutes

Return Value

Limit

at line 51
static Limit perMinutes(int $decayMinutes, int $maxAttempts)

Create a new rate limit using minutes as the decay time.

Parameters

int $decayMinutes
int $maxAttempts

Return Value

Limit

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

Create a new per-hour rate limit.

Parameters

int $maxAttempts
int $decayHours

Return Value

Limit

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

Create a new per-day rate limit.

Parameters

int $maxAttempts
int $decayDays

Return Value

Limit

at line 79
static Unlimited none()

Create a new unlimited rate limit.

Return Value

Unlimited