1. class
  2. Drupal
  3. \
  4. user
  5. \
  6. Event
  7. \
  8. UserFloodEvent

UserFloodEvent

class UserFloodEvent extends Event (View source)

Provides a user flood event for event listeners.

Properties

protected string $name

Flood event name.
protected int $threshold

Flood event threshold.
protected int $window

Flood event window.
protected string $identifier

Flood event identifier.
protected int $uid

Flood event uid.
protected string $ip

Flood event IP.

Methods

__construct(string $name, int $threshold, int $window, string $identifier)

Constructs a user flood event object.

string
getName()

Gets the name of the user flood event object.

int
getThreshold()

Gets the threshold for the user flood event object.

int
getWindow()

Gets the window for the user flood event object.

string
getIdentifier()

Gets the identifier of the user flood event object.

string
getIp()

Gets the IP of the user flood event object.

int
getUid()

Gets the uid of the user flood event object.

bool
hasIp()

Is the user flood event associated with an IP?

bool
hasUid()

Is the user flood event associated with a uid?

Details

at line 66
__construct(string $name, int $threshold, int $window, string $identifier)

Constructs a user flood event object.

Parameters

string $name

The name of the flood event.
int $threshold

The threshold for the flood event.
int $window

The window for the flood event.
string $identifier

The identifier of the flood event.

at line 91
string getName()

Gets the name of the user flood event object.

Return Value

string

The name of the flood event.

at line 101
int getThreshold()

Gets the threshold for the user flood event object.

Return Value

int

The threshold for the flood event.

at line 111
int getWindow()

Gets the window for the user flood event object.

Return Value

int

The window for the flood event.

at line 121
string getIdentifier()

Gets the identifier of the user flood event object.

Return Value

string

The identifier of the flood event.

at line 131
string getIp()

Gets the IP of the user flood event object.

Return Value

string

The IP of the flood event.

at line 141
int getUid()

Gets the uid of the user flood event object.

Return Value

int

The uid of the flood event.

at line 151
bool hasIp()

Is the user flood event associated with an IP?

Return Value

bool

Whether the event has an IP.

at line 161
bool hasUid()

Is the user flood event associated with a uid?

Return Value

bool

Whether the event has a uid.