Limiter implements iLimiter
Class Limiter
Table of Contents
Interfaces
- iLimiter
- Interface iLimiter
Methods
- __construct() : mixed
- Limiter constructor.
- getCaption() : string|null
- Get caption.
- getCurrent() : int
- Get current.
- getLimit() : int
- Get max.
- getParameter() : mixed|null
- Get parameter.
- getUnit() : string
- Get unit.
- getUnitName() : string
- Get unit name.
- isHidden() : bool
- Returns true if limiter should be hidden on the CRM-marketing settings page
- setParameter() : $this
- Set parameter.
Methods
__construct()
Limiter constructor.
public
__construct() : mixed
getCaption()
Get caption.
public
getCaption() : string|null
Return values
string|nullgetCurrent()
Get current.
public
getCurrent() : int
Return values
intgetLimit()
Get max.
public
getLimit() : int
Return values
intgetParameter()
Get parameter.
public
getParameter(string $name) : mixed|null
Parameters
- $name : string
-
Name.
Return values
mixed|nullgetUnit()
Get unit.
public
getUnit() : string
Examples: "14 d" is equals 14 days; "d" is equals 1 day.
Return values
stringgetUnitName()
Get unit name.
public
getUnitName() : string
Return values
stringisHidden()
Returns true if limiter should be hidden on the CRM-marketing settings page
public
isHidden() : bool
Tags
Return values
boolsetParameter()
Set parameter.
public
setParameter(string $name, mixed $value) : $this
Parameters
- $name : string
-
Name.
- $value : mixed
-
Value.