W3cubDocs

/Laravel 8

RateLimited

class RateLimited (View source)

Properties

protected RateLimiter $limiter The rate limiter instance.
protected string $limiterName The name of the rate limiter.
bool $shouldRelease Indicates if the job should be released if the limit is exceeded.

Methods

void __construct(string $limiterName)

Create a new middleware instance.

mixed handle(mixed $job, callable $next)

Process the job.

mixed handleJob(mixed $job, callable $next, array $limits)

Handle a rate limited job.

$this dontRelease()

Do not release the job back to the queue if limit is exceeded.

int getTimeUntilNextRetry(string $key)

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

Details

void __construct(string $limiterName)

Create a new middleware instance.

Parameters

string $limiterName

Return Value

void

mixed handle(mixed $job, callable $next)

Process the job.

Parameters

mixed $job
callable $next

Return Value

mixed

protected mixed handleJob(mixed $job, callable $next, array $limits)

Handle a rate limited job.

Parameters

mixed $job
callable $next
array $limits

Return Value

mixed

$this dontRelease()

Do not release the job back to the queue if limit is exceeded.

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

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