RateLimiter

класс RateLimiter (Просмотреть исходный код)

Трейты

Свойства

protected Repository	$cache	Реализация хранилища кэша.
protected array	$limiters	Настроенные обработчики объектов лимитов.

Методы

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

void

__construct(Repository $cache)

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

Подробности

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

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

Параметры

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

void __construct(Repository $cache)

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

Параметры

Repository

$cache

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

void

$this for(string $name, Closure $callback)

Зарегистрировать конфигурацию лимитера с заданным именем.

Параметры

string	$name
Closure	$callback

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

$this

Closure limiter(string $name)

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

Параметры

string

$name

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

Closure

mixed attempt(string $key, int $maxAttempts, Closure $callback, int $decaySeconds = 60)

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

Параметры

string	$key
int	$maxAttempts
Closure	$callback
int	$decaySeconds

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

mixed

bool tooManyAttempts(string $key, int $maxAttempts)

Определяет, превышено ли количество попыток для заданного ключа.

Параметры

string	$key
int	$maxAttempts

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

bool

int hit(string $key, int $decaySeconds = 60)

Увеличивает счётчик для заданного ключа на заданное время отсчёта.

Параметры

string	$key
int	$decaySeconds

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

int

mixed attempts(string $key)

Получает количество попыток для заданного ключа.

Параметры

string

$key

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

mixed

mixed resetAttempts(string $key)

Сбрасывает количество попыток для заданного ключа.

Параметры

string

$key

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

mixed

int remaining(string $key, int $maxAttempts)

Получает количество оставшихся попыток для заданного ключа.

Параметры

string	$key
int	$maxAttempts

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

int

int retriesLeft(string $key, int $maxAttempts)

Получает количество оставшихся попыток для заданного ключа.

Параметры

string	$key
int	$maxAttempts

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

int

void clear(string $key)

Очищает счётчики и таймер блокировки для заданного ключа.

Параметры

string

$key

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

void

int availableIn(string $key)

Получает количество секунд до повторного доступа к "ключу".

Параметры

string

$key

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

int

string cleanRateLimiterKey(string $key)

Очищает ключ ограничителя скорости от символов Юникода.

Параметры

string

$key

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

string

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