Spec-Zone.ru › Laravel 5.5

DurationLimiterBuilder

class DurationLimiterBuilder (View source)

Свойства

InteractsWithTime

Свойства

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

Методы

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

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

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

Получить отметку времени «доступно в».

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

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

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

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

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

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

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

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

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

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

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

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

смешанный тип then(вызываемый объект $callback, вызываемый объект $failure = null)

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

Подробности

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

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

Параметры

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

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

целое число

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

Получить отметку времени «доступно в».

Параметры

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

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

целое число

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

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

Параметры

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

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

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

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

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

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

целое число

void __construct(Соединение $connection, строка $name)

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

Параметры

Соединение $connection
строка $name

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

void

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

смешанный тип then(вызываемый объект $callback, вызываемый объект $failure = null)

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

Параметры

вызываемый объект $callback
вызываемый объект $failure

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

смешанный тип

Исключения

LimiterTimeoutException

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

Spec-Zone.ru

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