function DatabaseBackend::clear

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Flood/DatabaseBackend.php \Drupal\Core\Flood\DatabaseBackend::clear()
  2. 8.9.x core/lib/Drupal/Core/Flood/DatabaseBackend.php \Drupal\Core\Flood\DatabaseBackend::clear()
  3. 11.x core/lib/Drupal/Core/Flood/DatabaseBackend.php \Drupal\Core\Flood\DatabaseBackend::clear()

Makes the flood control mechanism forget an event for the current visitor.

Parameters

string $name: The name of an event.

string $identifier: (optional) Unique identifier of the current user. Defaults to the current user's IP address).

Overrides FloodInterface::clear

File

core/lib/Drupal/Core/Flood/DatabaseBackend.php, line 102

Class

DatabaseBackend
Defines the database flood backend. This is the default Drupal backend.

Namespace

Drupal\Core\Flood

Code

public function clear($name, $identifier = NULL) {
  if (!isset($identifier)) {
    $identifier = $this->requestStack
      ->getCurrentRequest()
      ->getClientIp();
  }
  try {
    $this->connection
      ->delete(static::TABLE_NAME)
      ->condition('event', $name)
      ->condition('identifier', $identifier)
      ->execute();
  } catch (\Exception $e) {
    $this->catchException($e);
  }
}

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