summaryrefslogtreecommitdiffstatshomepage
path: root/core/lib/Drupal/Core/Flood/PrefixFloodInterface.php
blob: 3732cc3cc1761cc372a12269b7871f826fa20f84 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<?php

namespace Drupal\Core\Flood;

/**
 * Defines an interface for flood controllers that clear by identifier prefix.
 */
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;

}