interface UserFloodControlInterface in Drupal 9

Defines an interface for user flood controllers.

Hierarchy

• interface \Drupal\Core\Flood\FloodInterface
  • interface \Drupal\user\UserFloodControlInterface

2 files declare their use of UserFloodControlInterface

UserAuthenticationController.php in core/modules/user/src/Controller/UserAuthenticationController.php

UserLoginForm.php in core/modules/user/src/Form/UserLoginForm.php

File

core/modules/user/src/UserFloodControlInterface.php, line 10

Namespace

Drupal\user

interface UserFloodControlInterface extends FloodInterface {

}

Members

Name	Modifiers	Type	Description	Overrides
FloodInterface::clear	public	function	Makes the flood control mechanism forget an event for the current visitor.	3
FloodInterface::garbageCollection	public	function	Cleans up expired flood events. This method is called automatically on cron run.	3
FloodInterface::isAllowed	public	function	Checks whether a user is allowed to proceed with the specified event.	3
FloodInterface::register	public	function	Registers an event for the current visitor to the flood control mechanism.	3