RateLimiter

class RateLimiter (View source)

Traits

InteractsWithTime

Properties

protected Repository

$cache

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

Methods

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime

int

availableAt(DateTimeInterface|DateInterval|int $delay)

Получить метку времени UNIX "доступно в" (available at).

from InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime

int

currentTime()

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

from InteractsWithTime

void

__construct(Repository $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)

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

Details

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

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

Parameters

DateTimeInterface|DateInterval|int

$delay

Return Value

int

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

Получить метку времени «доступно в» в формате 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 timestamp.

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

int

void __construct(Repository $cache)

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

Параметры

Repository

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