Spec-Zone.ru › Laravel 8

DurationLimiterBuilder

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

Трейты

InteractsWithTime

Свойства

Connection $connection

Подключение к Redis.

строка $name

Имя блокировки.

целое число $maxLocks

Максимальное количество блокировок, которое может быть получено за заданный временной интервал.

целое число $decay

Время поддержания окна блокировки.

целое число $timeout

Время блокировки до получения блокировки.

Методы

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(Connection $connection, string $name)

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

$this allow(int $maxLocks)

Установить максимальное количество блокировок, которые можно получить в течение заданного временного интервала.

$this every(DateTimeInterface|DateInterval|int $decay)

Установить продолжительность периода, в течение которого поддерживается окно блокировки.

$this block(int $timeout)

Установить время блокировки, пока не станет доступным замок.

mixed then(callable $callback, callable $failure = null)

Выполнить указанный обратный вызов, если замок получен, в противном случае вызвать обратный вызов ошибки.

Подробности

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(Connection $connection, string $name)

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

Параметры

Connection $connection
string $name

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

void

$this allow(int $maxLocks)

Установить максимальное количество блокировок, которые могут быть получены за определенный временной интервал.

Параметры

int $maxLocks

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

$this

$this every(DateTimeInterface|DateInterval|int $decay)

Установите время, в течение которого сохраняется окно блокировки.

Параметры

DateTimeInterface|DateInterval|int $decay

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

$this

$this block(int $timeout)

Установите время блокировки до тех пор, пока блокировка не станет доступной.

Параметры

int $timeout

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

$this

mixed then(callable $callback, callable $failure = null)

Выполните указанную функцию обратного вызова, если блокировка получена, в противном случае вызовите функцию обратного вызова ошибки.

Параметры

callable $callback
callable $failure

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

mixed

Исключения

LimiterTimeoutException

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Redis/Limiters/DurationLimiterBuilder.html

Spec-Zone.ru

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