class BanIPEvent extends Event (View source)

Properties

protected IPAddress $ipAddress The IP address that is going to be banned.
protected DateTime $banExpiration The ban expiration date/time (or null if not expiration).
protected bool $proceed Should we proceed or the ban has been canceled?

Methods

__construct(IPAddress $ipAddress, DateTime $banExpiration = null)

No description

getIPAddress()

Get the IP address that is going to be banned.

getBanExpiration()

Get the ban expiration date/time (or null if not expiration).

setBanExpiration(DateTime $banExpiration = null)

Set the ban expiration date/time (or null if not expiration).

cancelBan()

Cancel the ban.

bool
proceed()

Should we proceed or the ban has been canceled?

Details

__construct(IPAddress $ipAddress, DateTime $banExpiration = null)

Parameters

IPAddress $ipAddress the IP address that is going to be banned
DateTime $banExpiration the ban expiration date/time (or null if not expiration)

IPAddress getIPAddress()

Get the IP address that is going to be banned.

Return Value

IPAddress

DateTime getBanExpiration()

Get the ban expiration date/time (or null if not expiration).

Return Value

DateTime

BanIPEvent setBanExpiration(DateTime $banExpiration = null)

Set the ban expiration date/time (or null if not expiration).

Parameters

DateTime $banExpiration

Return Value

BanIPEvent

cancelBan()

Cancel the ban.

bool proceed()

Should we proceed or the ban has been canceled?

Return Value

bool