Mercurial > hg > isophonics-drupal-site
view core/modules/ban/src/BanIpManagerInterface.php @ 17:129ea1e6d783
Update, including to Drupal core 8.6.10
author | Chris Cannam |
---|---|
date | Thu, 28 Feb 2019 13:21:36 +0000 |
parents | 4c8ae668cc8c |
children |
line wrap: on
line source
<?php namespace Drupal\ban; /** * Provides an interface defining a BanIp manager. */ 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); }