RateLimiter

class RateLimiter (View source)

Traits

InteractsWithTime

Properties

protected Repository

$cache

Реализация хранилища кэша.

Methods

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime

int

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

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

from InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime

int

currentTime()

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

from 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)

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

string

cleanRateLimiterKey(string $key)

Очистить ключ Rate Limiter от символов Unicode.

Details

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

DateTimeInterface|int

protected int currentTime()

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

Return Value

int

void __construct(Repository $cache)

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

Parameters

Repository

$cache

Return Value

void

bool tooManyAttempts(string $key, int $maxAttempts)

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

Parameters

string	$key
int	$maxAttempts

Return Value

bool

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

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

Parameters

string	$key
int	$decaySeconds

Return Value

int

mixed attempts(string $key)

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

Parameters

string

$key

Return Value

mixed

mixed resetAttempts(string $key)

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

Parameters

string

$key

Return Value

mixed

int retriesLeft(string $key, int $maxAttempts)

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

Параметры

строка	$key
целое	$maxAttempts

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

целое

void clear(string $key)

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

Параметры

строка

$key

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

void

int availableIn(string $key)

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

Параметры

строка

$key

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

целое

string cleanRateLimiterKey(string $key)

Очистить ключ лимита скорости от символов юникода.

Параметры

строка

$key

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

строка

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