Ограничитель скорости

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

Свойства

protected Репозиторий

$cache

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

Методы

void

__construct(Репозиторий $cache)

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

bool

tooManyAttempts(string $key, int $maxAttempts, float|int $decayMinutes = 1)

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

void

lockout(string $key, int $decayMinutes)

Добавить ключ блокировки в кэш.

int

hit(string $key, float|int $decayMinutes = 1)

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

mixed

attempts(string $key)

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

mixed

resetAttempts(string $key)

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

int

retriesLeft(string $key, int $maxAttempts)

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

void

clear(string $key)

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

int

availableIn(string $key)

Получить количество секунд, которое потребуется до повторного доступа к «ключу».

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

void __construct(Репозиторий $cache)

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

Параметры

Репозиторий

$cache

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

void

bool tooManyAttempts(string $key, int $maxAttempts, float|int $decayMinutes = 1)

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

Параметры

string	$key
int	$maxAttempts
float\|int	$decayMinutes

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

bool

protected void lockout(string $key, int $decayMinutes)

Добавить ключ блокировки в кэш.

Параметры

string	$key
int	$decayMinutes

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

void

int hit(string $key, float|int $decayMinutes = 1)

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

Параметры

string	$key
float\|int	$decayMinutes

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

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/5.4/Illuminate/Cache/RateLimiter.html