Mercurial > hg > isophonics-drupal-site
annotate core/modules/ban/src/BanIpManagerInterface.php @ 19:fa3358dc1485 tip
Add ndrum files
author | Chris Cannam |
---|---|
date | Wed, 28 Aug 2019 13:14:47 +0100 |
parents | 4c8ae668cc8c |
children |
rev | line source |
---|---|
Chris@0 | 1 <?php |
Chris@0 | 2 |
Chris@0 | 3 namespace Drupal\ban; |
Chris@0 | 4 |
Chris@0 | 5 /** |
Chris@0 | 6 * Provides an interface defining a BanIp manager. |
Chris@0 | 7 */ |
Chris@0 | 8 interface BanIpManagerInterface { |
Chris@0 | 9 |
Chris@0 | 10 /** |
Chris@0 | 11 * Returns if this IP address is banned. |
Chris@0 | 12 * |
Chris@0 | 13 * @param string $ip |
Chris@0 | 14 * The IP address to check. |
Chris@0 | 15 * |
Chris@0 | 16 * @return bool |
Chris@0 | 17 * TRUE if the IP address is banned, FALSE otherwise. |
Chris@0 | 18 */ |
Chris@0 | 19 public function isBanned($ip); |
Chris@0 | 20 |
Chris@0 | 21 /** |
Chris@0 | 22 * Finds all banned IP addresses. |
Chris@0 | 23 * |
Chris@0 | 24 * @return \Drupal\Core\Database\StatementInterface |
Chris@0 | 25 * The result of the database query. |
Chris@0 | 26 */ |
Chris@0 | 27 public function findAll(); |
Chris@0 | 28 |
Chris@0 | 29 /** |
Chris@0 | 30 * Bans an IP address. |
Chris@0 | 31 * |
Chris@0 | 32 * @param string $ip |
Chris@0 | 33 * The IP address to ban. |
Chris@0 | 34 */ |
Chris@0 | 35 public function banIp($ip); |
Chris@0 | 36 |
Chris@0 | 37 /** |
Chris@0 | 38 * Unbans an IP address. |
Chris@0 | 39 * |
Chris@0 | 40 * @param string $id |
Chris@0 | 41 * The IP address to unban. |
Chris@0 | 42 */ |
Chris@0 | 43 public function unbanIp($id); |
Chris@0 | 44 |
Chris@0 | 45 /** |
Chris@0 | 46 * Finds a banned IP address by its ID. |
Chris@0 | 47 * |
Chris@0 | 48 * @param int $ban_id |
Chris@0 | 49 * The ID for a banned IP address. |
Chris@0 | 50 * |
Chris@0 | 51 * @return string|false |
Chris@0 | 52 * Either the banned IP address or FALSE if none exist with that ID. |
Chris@0 | 53 */ |
Chris@0 | 54 public function findById($ban_id); |
Chris@0 | 55 |
Chris@0 | 56 } |