Spec-Zone.ru › Laravel 10

RateLimitedWithRedis

class RateLimitedWithRedis extends RateLimited (View source)

Свойства

InteractsWithTime

Свойства

protected RateLimiter $limiter

Экземпляр ограничение скорости.

from RateLimited
protected string $limiterName

Имя ограничение скорости.

from RateLimited
bool $shouldRelease

Указывает, следует ли освободить задачу, если предел превышен.

from RateLimited
protected Factory $redis

Реализация фабрики Redis.

array $decaysAt

Отметка времени окончания текущей длительности по ключу.

Методы

void __construct(string $limiterName)

Создать новый экземпляр middleware.

mixed handle(mixed $job, callable $next)

Обработать задачу.

из RateLimited
mixed handleJob(mixed $job, callable $next, array $limits)

Обработать ограниченную задачу.

$this dontRelease()

Не возвращать задачу в очередь, если предел превышен.

из RateLimited
int getTimeUntilNextRetry(string $key)

Получить количество секунд, которое должно пройти до повторной попытки задачи.

array __sleep()

Подготовить объект для сериализации.

из RateLimited
void __wakeup()

Подготовить объект после десериализации.

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Получить количество секунд до указанной даты и времени.

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

Получить отметку времени «доступно в» в формате Unix.

из InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение представляет интервал, преобразовать его в объект DateTime.

из InteractsWithTime
int currentTime()

Получить текущее системное время в формате Unix.

из InteractsWithTime
bool tooManyAttempts(string $key, int $maxAttempts, int $decayMinutes)

Определить, было ли обращение к заданному ключу слишком много раз.

Подробности

void __construct(string $limiterName)

Создать новый экземпляр middleware.

Parameters

string $limiterName

Return Value

void

mixed handle(mixed $job, callable $next)

Обработать задачу.

Parameters

mixed $job
callable $next

Return Value

mixed

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

Обработать задачу с ограничением скорости.

Параметры

mixed $job
callable $next
array $limits

Значение возврата

mixed

$this dontRelease()

Не возвращать задачу обратно в очередь, если превышено ограничение.

Значение возврата

$this

protected int getTimeUntilNextRetry(string $key)

Получить количество секунд, которое должно пройти до повторной попытки выполнения задачи.

Параметры

string $key

Значение возврата

int

array __sleep()

Подготовить объект к сериализации.

Значение возврата

array

void __wakeup()

Подготовить объект после десериализации.

Значение возврата

void

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

Получить количество секунд до указанной даты и времени.

Параметры

DateTimeInterface|DateInterval|int $delay

Значение возврата

int

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

Получить отметку времени «доступно в» в формате UNIX timestamp.

Параметры

DateTimeInterface|DateInterval|int $delay

Значение возврата

int

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

Если заданное значение представляет интервал, преобразовать его в экземпляр DateTime.

Параметры

DateTimeInterface|DateInterval|int $delay

Значение возврата

DateTimeInterface|int

protected int currentTime()

Получить текущее системное время в формате UNIX timestamp.

Значение возврата

int

protected bool tooManyAttempts(string $key, int $maxAttempts, int $decayMinutes)

Определить, был ли данный ключ «обращён» слишком много раз.

Параметры

string $key
int $maxAttempts
int $decayMinutes

Возвращаемое значение

bool

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API