defender-security / src / component / known-bots / bots / bots-interface.php

bots-interface.php in Defender Security – Malware Scanner, Login Security & Firewall 6.3.0, at src/component/known-bots/bots/bots-interface.php

46 lines 1001 B

Raw Download Zip

1	<?php
2	/**
3	* The interface for bots class.
4	*
5	* @package WP_Defender\Component\Known_Bots\Bots
6	*/
7
8	namespace WP_Defender\Component\Known_Bots\Bots;
9
10	interface Bots_Interface {
11	/**
12	* Returns the name of the bot.
13	*
14	* @return string The name of the bot.
15	*/
16	public function get_name(): string;
17
18	/**
19	* Fetches the IPs for the bot.
20	*
21	* This method retrieves the IP ranges used by the bot from an endpoint.
22	* It returns an array of IP addresses in both IPv4 and IPv6 formats.
23	*
24	* @return array An array of IP addresses used by the bot.
25	*/
26	public function fetch_ips(): array;
27
28	/**
29	* Checks if the given or current user agent belongs to the bot.
30	*
31	* @param string $user_agent Optional user agent string to check.
32	*
33	* @return bool
34	*/
35	public function is_ua( string $user_agent = '' ): bool;
36
37	/**
38	* Checks if the given IP belongs to the bot.
39	*
40	* @param string $ip The IP address to check.
41	*
42	* @return bool
43	*/
44	public function is_ip( string $ip ): bool;
45	}
46