interface PrefixFloodInterface

Same name in other branches
  1. 11.x core/lib/Drupal/Core/Flood/PrefixFloodInterface.php \Drupal\Core\Flood\PrefixFloodInterface

Defines an interface for flood controllers that clear by identifier prefix.

Hierarchy

Expanded class hierarchy of PrefixFloodInterface

All classes that implement PrefixFloodInterface

1 file declares its use of PrefixFloodInterface
User.php in core/modules/user/src/Entity/User.php

File

core/lib/Drupal/Core/Flood/PrefixFloodInterface.php, line 8

Namespace

Drupal\Core\Flood
View source 
interface PrefixFloodInterface {
    
    /**
     * Makes the flood control mechanism forget an event by identifier prefix.
     *
     * @param string $name
     *   The name of an event.
     * @param string $prefix
     *   The prefix of the identifier to be cleared.
     */
    public function clearByPrefix(string $name, string $prefix) : void;

}

Members

Title Modifiers Object type Summary Overrides
PrefixFloodInterface::clearByPrefix public function Makes the flood control mechanism forget an event by identifier prefix. 2

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