Spec-Zone.ru › Laravel 5.8

DurationLimiterBuilder

class DurationLimiterBuilder (View source)

Свойства

InteractsWithTime

Свойства

Connection $connection Подключение к Redis.
string $name Имя блокировки.
int $maxLocks Максимальное количество блокировок, которые могут быть получены за заданный интервал времени.
int $decay Время, в течение которого поддерживается окно блокировки.
int $timeout Время ожидания, пока будет доступна блокировка.

Методы

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime
int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

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

из InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime
int currentTime()

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

из InteractsWithTime
void __construct(Connection $connection, string $name)

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

$this allow(int $maxLocks)

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

$this every(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 timestamp.

Параметры

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

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

Параметры

Connection $connection
string $name

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

void

$this allow(int $maxLocks)

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

Параметры

int $maxLocks

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

$this

$this every(int $decay)

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

Параметры

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/5.8/Illuminate/Redis/Limiters/DurationLimiterBuilder.html

Spec-Zone.ru

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