PrefixFloodInterface.php

Same filename in other branches
  1. 10 core/lib/Drupal/Core/Flood/PrefixFloodInterface.php

Namespace

Drupal\Core\Flood

File

core/lib/Drupal/Core/Flood/PrefixFloodInterface.php

View source
<?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;

}

Interfaces

Title Deprecated Summary
PrefixFloodInterface Defines an interface for flood controllers that clear by identifier prefix.

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