Spec-Zone.ru › Laravel 5.7

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

класс RateLimiter (Просмотр исходного кода)

Трейты

InteractsWithTime

Свойства

protected Репозиторий $cache Реализация хранилища кэша.

Методы

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(Репозиторий $cache)

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

bool tooManyAttempts(string $key, int $maxAttempts)

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

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)

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

Подробности

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

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

Параметры

DateTimeInterface|DateInterval|int $delay

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

int

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(Репозиторий $cache)

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

Параметры

Репозиторий $cache

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

void

bool tooManyAttempts(string $key, int $maxAttempts)

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

Параметры

string $key
int $maxAttempts

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

bool

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

Spec-Zone.ru

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