W3cubDocs

/Laravel 11

ThrottlesExceptionsWithRedis

class ThrottlesExceptionsWithRedis extends ThrottlesExceptions (View source)

Traits

InteractsWithTime

Properties

protected string $key

The developer specified key that the rate limiter should use.

 from ThrottlesExceptions
protected bool $byJob

Indicates whether the throttle key should use the job's UUID.

 from ThrottlesExceptions
protected int $maxAttempts

The maximum number of attempts allowed before rate limiting applies.

 from ThrottlesExceptions
protected int $decaySeconds

The number of seconds until the maximum attempts are reset.

 from ThrottlesExceptions
protected int $retryAfterMinutes

The number of minutes to wait before retrying the job after an exception.

 from ThrottlesExceptions
protected callable $reportCallback

The callback that determines if the exception should be reported.

 from ThrottlesExceptions
protected callable $whenCallback

The callback that determines if rate limiting should apply.

 from ThrottlesExceptions
protected string $prefix

The prefix of the rate limiter key.

 from ThrottlesExceptions
protected DurationLimiter $limiter

The rate limiter instance.
protected Factory $redis

The Redis factory implementation.

Methods

void __construct(int $maxAttempts = 10, int $decaySeconds = 600)

Create a new middleware instance.

 from ThrottlesExceptions
mixed handle(mixed $job, callable $next)

Process the job.
$this when(callable $callback)

Specify a callback that should determine if rate limiting behavior should apply.

 from ThrottlesExceptions
$this withPrefix(string $prefix)

Set the prefix of the rate limiter key.

 from ThrottlesExceptions
$this backoff(int $backoff)

Specify the number of minutes a job should be delayed when it is released (before it has reached its max exceptions).

 from ThrottlesExceptions
string getKey(mixed $job)

Get the cache key associated for the rate limiter.

 from ThrottlesExceptions
$this by(string $key)

Set the value that the rate limiter should be keyed by.

 from ThrottlesExceptions
$this byJob()

Indicate that the throttle key should use the job's UUID.

 from ThrottlesExceptions
$this report(callable|null $callback = null)

Report exceptions and optionally specify a callback that determines if the exception should be reported.

 from ThrottlesExceptions
int getTimeUntilNextRetry(string $key)

Get the number of seconds that should elapse before the job is retried.

 from ThrottlesExceptions
int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

 from InteractsWithTime
int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

 from InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

 from InteractsWithTime
int currentTime()

Get the current system time as a UNIX timestamp.

 from InteractsWithTime
string runTimeForHumans(float $startTime, float $endTime = null)

Given a start time, format the total run time for human readability.

 from InteractsWithTime

Details

void __construct(int $maxAttempts = 10, int $decaySeconds = 600)

Create a new middleware instance.

Parameters

int $maxAttempts
int $decaySeconds

Return Value

void

mixed handle(mixed $job, callable $next)

Process the job.

Parameters

mixed $job
callable $next

Return Value

mixed

$this when(callable $callback)

Specify a callback that should determine if rate limiting behavior should apply.

Parameters

callable $callback

Return Value

$this

$this withPrefix(string $prefix)

Set the prefix of the rate limiter key.

Parameters

string $prefix

Return Value

$this

$this backoff(int $backoff)

Specify the number of minutes a job should be delayed when it is released (before it has reached its max exceptions).

Parameters

int $backoff

Return Value

$this

protected string getKey(mixed $job)

Get the cache key associated for the rate limiter.

Parameters

mixed $job

Return Value

string

$this by(string $key)

Set the value that the rate limiter should be keyed by.

Parameters

string $key

Return Value

$this

$this byJob()

Indicate that the throttle key should use the job's UUID.

Return Value

$this

$this report(callable|null $callback = null)

Report exceptions and optionally specify a callback that determines if the exception should be reported.

Parameters

callable|null $callback

Return Value

$this

protected int getTimeUntilNextRetry(string $key)

Get the number of seconds that should elapse before the job is retried.

Parameters

string $key

Return Value

int

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

DateTimeInterface|int

protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

protected string runTimeForHumans(float $startTime, float $endTime = null)

Given a start time, format the total run time for human readability.

Parameters

float $startTime
float $endTime

Return Value

string

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Queue/Middleware/ThrottlesExceptionsWithRedis.html