summaryrefslogtreecommitdiffstatshomepage
path: root/core/modules/user/src/Event/UserEvents.php
blob: 7c17e272d346270ef6b85beaf147e9d1e47d8a41 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
<?php

namespace Drupal\user\Event;

/**
 * Defines events for the user module.
 */
final class UserEvents {

  /**
   * The name of the event fired when a login is blocked by flood control.
   *
   * This event allows modules to perform an action whenever flood control has
   * been triggered by excessive login attempts for a particular user account.
   * The event listener method receives a \Drupal\user\Event\UserFloodEvent
   * instance.
   *
   * @Event
   *
   * @see: \Drupal\user\UserFloodControl::isAllowed
   * @see: \Drupal\user\EventSubscriber\UserFloodSubscriber
   *
   * @var string
   */
  const FLOOD_BLOCKED_USER = 'user.flood_blocked_user';

  /**
   * The name of the event fired when a login is blocked by flood control.
   *
   * This event allows modules to perform an action whenever flood control has
   * been triggered by excessive login attempts from a particular IP. The event
   * listener method receives a \Drupal\user\Event\UserFloodEvent instance.
   *
   * @Event
   *
   * @see: \Drupal\user\UserFloodControl::isAllowed
   * @see: \Drupal\user\EventSubscriber\UserFloodSubscriber
   *
   * @var string
   */
  const FLOOD_BLOCKED_IP = 'user.flood_blocked_ip';

}