interface BanIpManagerInterface in Drupal 9

Provides an interface defining a BanIp manager.

Hierarchy

• interface \Drupal\ban\BanIpManagerInterface

3 files declare their use of BanIpManagerInterface

BanAdmin.php in core/modules/ban/src/Form/BanAdmin.php

BanDelete.php in core/modules/ban/src/Form/BanDelete.php

BlockedIp.php in core/modules/ban/src/Plugin/migrate/destination/BlockedIp.php

File

core/modules/ban/src/BanIpManagerInterface.php, line 8

Namespace

Drupal\ban

interface BanIpManagerInterface {

  /**
   * Returns if this IP address is banned.
   *
   * @param string $ip
   *   The IP address to check.
   *
   * @return bool
   *   TRUE if the IP address is banned, FALSE otherwise.
   */
  public function isBanned($ip);

  /**
   * Finds all banned IP addresses.
   *
   * @return \Drupal\Core\Database\StatementInterface
   *   The result of the database query.
   */
  public function findAll();

  /**
   * Bans an IP address.
   *
   * @param string $ip
   *   The IP address to ban.
   */
  public function banIp($ip);

  /**
   * Unbans an IP address.
   *
   * @param string $id
   *   The IP address to unban.
   */
  public function unbanIp($id);

  /**
   * Finds a banned IP address by its ID.
   *
   * @param int $ban_id
   *   The ID for a banned IP address.
   *
   * @return string|false
   *   Either the banned IP address or FALSE if none exist with that ID.
   */
  public function findById($ban_id);

}

Members

Name	Modifiers	Type	Description	Overrides
BanIpManagerInterface::banIp	public	function	Bans an IP address.	1
BanIpManagerInterface::findAll	public	function	Finds all banned IP addresses.	1
BanIpManagerInterface::findById	public	function	Finds a banned IP address by its ID.	1
BanIpManagerInterface::isBanned	public	function	Returns if this IP address is banned.	1
BanIpManagerInterface::unbanIp	public	function	Unbans an IP address.	1