Spec-Zone.ru › Laravel 5.6

DurationLimiterBuilder

class DurationLimiterBuilder (View source)

Свойства

InteractsWithTime

Свойства

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

Методы

целое число secondsUntil(DateTimeInterface|DateInterval|целое число $delay)

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

из InteractsWithTime
целое число availableAt(DateTimeInterface|DateInterval|целое число $delay)

Получить отметку времени Unix, когда доступна блокировка.

из InteractsWithTime
DateTimeInterface|целое число parseDateInterval(DateTimeInterface|DateInterval|целое число $delay)

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

из InteractsWithTime
целое число currentTime()

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

из InteractsWithTime
void __construct(Подключение $connection, строка $name)

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

$this allow(целое число $maxLocks)

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

$this every(целое число $decay)

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

$this block(целое число $timeout)

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

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

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

Детали

protected целое число secondsUntil(DateTimeInterface|DateInterval|целое число $delay)

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

Параметры

DateTimeInterface|DateInterval|целое число $delay

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

целое число

protected целое число availableAt(DateTimeInterface|DateInterval|целое число $delay)

Получить отметку времени Unix, когда доступна блокировка.

Параметры

DateTimeInterface|DateInterval|целое число $delay

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

целое число

protected DateTimeInterface|целое число parseDateInterval(DateTimeInterface|DateInterval|целое число $delay)

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

Параметры

DateTimeInterface|DateInterval|целое число $delay

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

DateTimeInterface|целое число

protected целое число currentTime()

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

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

целое число

void __construct(Подключение $connection, строка $name)

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

Параметры

Подключение $connection
строка $name

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

void

$this allow(целое число $maxLocks)

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

Параметры

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

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

$this

$this every(целое число $decay)

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

Параметры

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

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

$this

$this block(целое число $timeout)

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

Параметры

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

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

$this

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

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

Параметры

callable $callback
callable $failure

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

mixed

Исключения

Исключение истечения времени ожидания блокировки

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

Spec-Zone.ru

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