RateLimiter

class RateLimiter (View source)

Свойства

InteractsWithTime

Свойства

protected Repository

$cache

Реализация кэша.

Методы

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime

int

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

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

из InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime

int

currentTime()

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

из InteractsWithTime

void

__construct(Repository $cache)

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

bool

tooManyAttempts(string $key, int $maxAttempts)

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

int

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

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

mixed

attempts(string $key)

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

mixed

resetAttempts(string $key)

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

int

retriesLeft(string $key, int $maxAttempts)

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

void

clear(string $key)

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

int

availableIn(string $key)

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

Подробное описание

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

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

END_OF_DOCUMENT_MARKER

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

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

Параметры

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

void __construct(Repository $cache)

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

Параметры

Repository

$cache

Значение результата

void

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 retriesLeft(string $key, int $maxAttempts)

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

Параметры

string	$key
int	$maxAttempts

Значение результата

int

void clear(string $key)

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

Параметры

string

$key

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

void

int availableIn(string $key)

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

Параметры

string

$key

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

int

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