class UserFloodEvent

Same name in other branches
  1. 9 core/modules/user/src/Event/UserFloodEvent.php \Drupal\user\Event\UserFloodEvent
  2. 11.x core/modules/user/src/Event/UserFloodEvent.php \Drupal\user\Event\UserFloodEvent

Provides a user flood event for event listeners.

Hierarchy

  • class \Drupal\Component\EventDispatcher\Event extends \Symfony\Contracts\EventDispatcher\Event
    • class \Drupal\user\Event\UserFloodEvent extends \Drupal\Component\EventDispatcher\Event

Expanded class hierarchy of UserFloodEvent

2 files declare their use of UserFloodEvent
UserFloodControl.php in core/modules/user/src/UserFloodControl.php
UserFloodSubscriber.php in core/modules/user/src/EventSubscriber/UserFloodSubscriber.php

File

core/modules/user/src/Event/UserFloodEvent.php, line 10

Namespace

Drupal\user\Event
View source 
class UserFloodEvent extends Event {
    
    /**
     * Flood event name.
     *
     * @var string
     */
    protected $name;
    
    /**
     * Flood event threshold.
     *
     * @var int
     */
    protected $threshold;
    
    /**
     * Flood event window.
     *
     * @var int
     */
    protected $window;
    
    /**
     * Flood event identifier.
     *
     * @var string
     */
    protected $identifier;
    
    /**
     * Flood event uid.
     *
     * @var int
     */
    protected $uid = NULL;
    
    /**
     * Flood event IP.
     *
     * @var string
     */
    protected $ip = NULL;
    
    /**
     * Constructs a user flood event object.
     *
     * @param string $name
     *   The name of the flood event.
     * @param int $threshold
     *   The threshold for the flood event.
     * @param int $window
     *   The window for the flood event.
     * @param string $identifier
     *   The identifier of the flood event.
     */
    public function __construct($name, $threshold, $window, $identifier) {
        $this->name = $name;
        $this->threshold = $threshold;
        $this->window = $window;
        $this->identifier = $identifier;
        // The identifier could be a uid or an IP, or a composite of both.
        if (is_numeric($identifier)) {
            $this->uid = $identifier;
            return;
        }
        if (str_contains($identifier, '-')) {
            [
                $uid,
                $ip,
            ] = explode('-', $identifier);
            $this->uid = $uid;
            $this->ip = $ip;
            return;
        }
        $this->ip = $identifier;
    }
    
    /**
     * Gets the name of the user flood event object.
     *
     * @return string
     *   The name of the flood event.
     */
    public function getName() {
        return $this->name;
    }
    
    /**
     * Gets the threshold for the user flood event object.
     *
     * @return int
     *   The threshold for the flood event.
     */
    public function getThreshold() {
        return $this->threshold;
    }
    
    /**
     * Gets the window for the user flood event object.
     *
     * @return int
     *   The window for the flood event.
     */
    public function getWindow() {
        return $this->window;
    }
    
    /**
     * Gets the identifier of the user flood event object.
     *
     * @return string
     *   The identifier of the flood event.
     */
    public function getIdentifier() {
        return $this->identifier;
    }
    
    /**
     * Gets the IP of the user flood event object.
     *
     * @return string
     *   The IP of the flood event.
     */
    public function getIp() {
        return $this->ip;
    }
    
    /**
     * Gets the uid of the user flood event object.
     *
     * @return int
     *   The uid of the flood event.
     */
    public function getUid() {
        return $this->uid;
    }
    
    /**
     * Is the user flood event associated with an IP?
     *
     * @return bool
     *   Whether the event has an IP.
     */
    public function hasIp() {
        return !empty($this->ip);
    }
    
    /**
     * Is the user flood event associated with a uid?
     *
     * @return bool
     *   Whether the event has a uid.
     */
    public function hasUid() {
        return !empty($this->uid);
    }

}

Members

Title Modifiers Object type Summary
UserFloodEvent::$identifier protected property Flood event identifier.
UserFloodEvent::$ip protected property Flood event IP.
UserFloodEvent::$name protected property Flood event name.
UserFloodEvent::$threshold protected property Flood event threshold.
UserFloodEvent::$uid protected property Flood event uid.
UserFloodEvent::$window protected property Flood event window.
UserFloodEvent::getIdentifier public function Gets the identifier of the user flood event object.
UserFloodEvent::getIp public function Gets the IP of the user flood event object.
UserFloodEvent::getName public function Gets the name of the user flood event object.
UserFloodEvent::getThreshold public function Gets the threshold for the user flood event object.
UserFloodEvent::getUid public function Gets the uid of the user flood event object.
UserFloodEvent::getWindow public function Gets the window for the user flood event object.
UserFloodEvent::hasIp public function Is the user flood event associated with an IP?
UserFloodEvent::hasUid public function Is the user flood event associated with a uid?
UserFloodEvent::__construct public function Constructs a user flood event object.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.