Spec-Zone.ru › Laravel 9

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)

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

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

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

$this dontRelease()

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

from RateLimited
int getTimeUntilNextRetry(string $key)

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

array __sleep()

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

from RateLimited
void __wakeup()

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

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

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

Получить метку времени в формате UNIX для значения "доступно с".

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

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

из InteractsWithTime
int currentTime()

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

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

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

Подробности

void __construct(string $limiterName)

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

Параметры

string $limiterName

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

void

mixed handle(mixed $job, callable $next)

Обработать задание.

Параметры

mixed $job
callable $next

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

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)

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

Параметры

DateTimeInterface|DateInterval|int $delay

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

int

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

Получить метку времени UNIX для "доступно в" (available at).

Параметры

DateTimeInterface|DateInterval|int $delay

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

int

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

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

Параметры

DateTimeInterface|DateInterval|int $delay

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

DateTimeInterface|int

protected int currentTime()

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

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

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/9.x/Illuminate/Queue/Middleware/RateLimitedWithRedis.html

Spec-Zone.ru

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