IpAccessControlCategory
class IpAccessControlCategory (View source)
Represent an IP Access Control Category.
Constants
| TIMEWINDOW_UNITS |
The units of the time limit. Array keys are the number of seconds, array values are the Unicode CLDR names of these numbers of seconds. |
Properties
| protected int|null | $ipAccessControlCategoryID | The IP Access Control Category identifier. |
|
| protected string | $handle | The IP Access Control Category handle. |
|
| protected string | $name | The IP Access Control Category name. |
|
| protected Package|null | $package | The package that defines this IP Access Control Category. |
|
| protected bool | $enabled | Is this IP Access Control Category enabled? |
|
| protected int | $maxEvents | The maximum allowed events in the time window. |
|
| protected int|null | $timeWindow | The time window (in seconds) where the events should be counted (NULL means no limits). |
|
| protected int|null | $banDuration | The duration (in seconds) of the ban when the maximum number of events occur in the time window (NULL means forever). |
|
| protected bool | $siteSpecific | Is this IP Access Control Category site-specific? |
|
| protected string | $logChannelHandle | The log channel handle. |
|
| protected ArrayCollection|IpAccessControlEvent[] | $events | The list of recorded events associated to this category. |
|
| protected ArrayCollection|IpAccessControlRange[] | $ranges | The list of defined ranges associated to this category. |
Methods
Initialize the instance.
Get the IP Access Control Category identifier.
Get the IP Access Control handle.
Set the IP Access Control handle.
Get the IP Access Control name.
Get the IP Access Control display name.
Set the IP Access Control name.
Get the package that defines this IP Access Control Category.
Is this IP Access Control Category enabled?
Is this IP Access Control Category enabled?
Get the maximum allowed events in the time window.
Set the maximum allowed events in the time window.
Get the time window (in seconds) where the events should be counted (NULL means no limits).
Get the time window (in seconds) where the events should be counted (NULL means no limits).
Get the duration (in seconds) of the ban when the maximum number of events occur in the time window (NULL means forever).
Set the duration (in seconds) of the ban when the maximum number of events occur in the time window (NULL means forever).
Is this IP Access Control Category site-specific?
Is this IP Access Control Category site-specific?
Get the log channel handle (empty string if log is disabled).
Set the log channel handle (empty string if log is disabled).
Get the list of recorded events associated to this category.
Get the list of defined ranges associated to this category.
Get the representation of a time window expressed in seconds.
No description
Details
__construct()
Initialize the instance.
int|null
getIpAccessControlCategoryID()
Get the IP Access Control Category identifier.
string
getHandle()
Get the IP Access Control handle.
$this
setHandle(string $value)
Set the IP Access Control handle.
string
getName()
Get the IP Access Control name.
string
getDisplayName()
Get the IP Access Control display name.
$this
setName(string $value)
Set the IP Access Control name.
Package|null
getPackage()
Get the package that defines this IP Access Control Category.
$this
setPackage(Package $value = null)
Set the package that defines this IP Access Control Category.
bool
isEnabled()
Is this IP Access Control Category enabled?
$this
setEnabled(bool $value)
Is this IP Access Control Category enabled?
int
getMaxEvents()
Get the maximum allowed events in the time window.
$this
setMaxEvents(int $value)
Set the maximum allowed events in the time window.
int|null
getTimeWindow()
Get the time window (in seconds) where the events should be counted (NULL means no limits).
$this
setTimeWindow(int|null $value)
Get the time window (in seconds) where the events should be counted (NULL means no limits).
int|null
getBanDuration()
Get the duration (in seconds) of the ban when the maximum number of events occur in the time window (NULL means forever).
$this
setBanDuration(int|null $value)
Set the duration (in seconds) of the ban when the maximum number of events occur in the time window (NULL means forever).
bool
isSiteSpecific()
Is this IP Access Control Category site-specific?
$this
setSiteSpecific(bool $value)
Is this IP Access Control Category site-specific?
string
getLogChannelHandle()
Get the log channel handle (empty string if log is disabled).
$this
setLogChannelHandle(string $value)
Set the log channel handle (empty string if log is disabled).
ArrayCollection|IpAccessControlEvent[]
getEvents()
Get the list of recorded events associated to this category.
ArrayCollection|IpAccessControlRange[]
getRanges()
Get the list of defined ranges associated to this category.
static array|null
splitTimeWindow(int|null $timeWindow)
Get the representation of a time window expressed in seconds.
string
describeTimeWindow()
No description