Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/modules/ban/src/BanIpManagerInterface.php

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\ban\BanIpManagerInterface.
6	*/
7
8	namespace Drupal\ban;
9
10	/**
11	* Provides an interface defining a BanIp manager.
12	*/
13	interface BanIpManagerInterface {
14
15	/**
16	* Returns if this IP address is banned.
17	*
18	* @param string $ip
19	* The IP address to check.
20	*
21	* @return bool
22	* TRUE if the IP address is banned, FALSE otherwise.
23	*/
24	public function isBanned($ip);
25
26	/**
27	* Finds all banned IP addresses.
28	*
29	* @return \Drupal\Core\Database\StatementInterface
30	* The result of the database query.
31	*/
32	public function findAll();
33
34	/**
35	* Bans an IP address.
36	*
37	* @param string $ip
38	* The IP address to ban.
39	*/
40	public function banIp($ip);
41
42	/**
43	* Unbans an IP address.
44	*
45	* @param string $id
46	* The IP address to unban.
47	*/
48	public function unbanIp($id);
49
50	/**
51	* Finds a banned IP address by its ID.
52	*
53	* @param int $ban_id
54	* The ID for a banned IP address.
55	*
56	* @return string\|false
57	* Either the banned IP address or FALSE if none exist with that ID.
58	*/
59	public function findById($ban_id);
60
61	}