Класс CountLimiter

Граф наследования:CountLimiter:

Открытые члены
	__construct ()
	withName ($name)
	withCaption ($caption)
	withLimit ($limit)
	withInterval ($interval)
	withUnit ($unit)
	withUnitName ($unitName)
	withCurrent ($callable)
	getInitialLimit ()
	getLimit ()
	getUnit ()
	getUnitName ()
	getCaption ()
	getName ()
	getText ()
	getParameter ($name)
	setParameter ($name, $value)
	inc ($amount=1)
	getAvailable ()
	getCurrent ()
	getTimestamp ()
	setHidden (bool $hidden)
	isHidden ()

Открытые статические члены
static	create ()
static	getUnitInterval ($unit)

Дополнительные унаследованные члены
Поля данных унаследованные от iLimiter
const	MONTHS = 'months'
const	DAYS = 'days'
const	HOURS = 'hours'
const	MINUTES = 'minutes'

Подробное описание

См. определение в файле countlimiter.php строка 22

Конструктор(ы)

__construct()

__construct

(

)

Limitation constructor.

См. определение в файле countlimiter.php строка 108

Методы

create()

create ( )

static

Create instance.

Возвращает

static

См. определение в файле countlimiter.php строка 55

getAvailable()

getAvailable

(

)

Get current limit rate.

Возвращает

integer

См. определение в файле countlimiter.php строка 392

getCaption()

getCaption

(

)

Get caption.

Возвращает

string

Замещает iLimiter.

См. определение в файле countlimiter.php строка 288

getCurrent()

getCurrent

(

)

Get current limit rate.

Возвращает

integer

Замещает iLimiter.

См. определение в файле countlimiter.php строка 403

getInitialLimit()

getInitialLimit

(

)

Get initial limit.

Возвращает

integer

См. определение в файле countlimiter.php строка 208

getLimit()

getLimit

(

)

Get limit rate.

Возвращает

integer

Замещает iLimiter.

См. определение в файле countlimiter.php строка 218

getName()

getName

(

)

Get name.

Возвращает

string

См. определение в файле countlimiter.php строка 298

getParameter()

getParameter

(

$name

)

Get parameter.

Аргументы

string

$name

Name.

Возвращает

mixed|null

Замещает iLimiter.

См. определение в файле countlimiter.php строка 327

getText()

getText

(

)

Get text.

Возвращает

string

См. определение в файле countlimiter.php строка 308

getTimestamp()

getTimestamp

(

)

Get timestamp of current period.

Возвращает

int

См. определение в файле countlimiter.php строка 442

getUnit()

getUnit

(

)

Get unit.

Возвращает

string

Замещает iLimiter.

См. определение в файле countlimiter.php строка 235

getUnitInterval()

getUnitInterval ( $unit )

static

Create unit interval.

Аргументы

string

$unit

Unit.

Возвращает

integer

См. определение в файле countlimiter.php строка 78

getUnitName()

getUnitName

(

)

Get unit name.

Возвращает

string

Замещает iLimiter.

См. определение в файле countlimiter.php строка 245

inc()

inc

(

$amount = 1

)

Inc current limit rate.

Аргументы

integer

$amount

Amount.

Возвращает

$this

Исключения

SystemException

См. определение в файле countlimiter.php строка 352

isHidden()

isHidden

(

)

@inheritDoc

Замещает iLimiter.

См. определение в файле countlimiter.php строка 476

setHidden()

setHidden

(

bool

$hidden

)

Set limiter hidden.

Аргументы

bool

$hidden

Возвращает

$this

См. определение в файле countlimiter.php строка 468

setParameter()

setParameter	(		$name,
			$value )

Set parameter.

Аргументы

string	$name	Name.
mixed	$value	Value.

Возвращает

$this

Замещает iLimiter.

См. определение в файле countlimiter.php строка 339

withCaption()

withCaption

(

$caption

)

With caption.

Аргументы

string

$caption

Caption.

Возвращает

$this

См. определение в файле countlimiter.php строка 130

withCurrent()

withCurrent

(

$callable

)

Set current.

Аргументы

callable

$callable

Callable.

Возвращает

$this

Исключения

ArgumentException

См. определение в файле countlimiter.php строка 192

withInterval()

withInterval

(

$interval

)

With time interval in seconds.

Аргументы

integer

$interval

Time interval.

Возвращает

$this

См. определение в файле countlimiter.php строка 154

withLimit()

withLimit

(

$limit

)

With limit.

Аргументы

integer

$limit

Limit.

Возвращает

$this

См. определение в файле countlimiter.php строка 142

withName()

withName

(

$name

)

With name.

Аргументы

string

$name

Name.

Возвращает

$this

См. определение в файле countlimiter.php строка 118

withUnit()

withUnit

(

$unit

)

With unit.

Аргументы

string

$unit

Unit.

Возвращает

$this

См. определение в файле countlimiter.php строка 166

withUnitName()

withUnitName

(

$unitName

)

With unit name.

Аргументы

string

$unitName

Unit.

Возвращает

$this

См. определение в файле countlimiter.php строка 179

---

Объявления и описания членов класса находятся в файле:

• C:/bitrix/modules/sender/lib/transport/countlimiter.php