Skip to content

Commit 95eca28

Browse files
authored
update readme to add methods information
1 parent 5a81a9a commit 95eca28

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,29 @@
11
# IP2Proxy PHP Module
22

3-
This module allows user to query an IP address if it was being used as open proxy, web proxy, VPN anonymizer and TOR exits. It lookup the proxy IP address from **IP2Location BIN Data** file. This data file can be downloaded at
3+
This module allows user to query an IP address if it was being used as open proxy, web proxy, VPN anonymizer and TOR exits. It lookup the proxy IP address from **IP2Proxy BIN Data** file. This data file can be downloaded at
44

55
* Free IP2Proxy BIN Data: http://lite.ip2location.com
66
* Commercial IP2Proxy BIN Data: http://www.ip2location.com/proxy-database
77

8+
## Methods
9+
Below are the methods supported in this class.
10+
11+
|Method Name|Description|
12+
|---|---|
13+
|open|Open the IP2Proxy BIN data for lookup. Please see the **Usage** section of the 3 modes supported to load the BIN data file.|
14+
|close|Close and clean up the file pointer.|
15+
|getPackageVersion|Get the package version (1 to 4 for PX1 to PX4 respectively).|
16+
|getModuleVersion|Get the module version.|
17+
|getDatabaseVersion|Get the database version.|
18+
|isProxy|Check wether if an IP address was a proxy. Returned value:<ul><li>-1 : errors</li><li>0 : not a proxy</li><li>1 : a proxy</li><li>2 : a data center IP address</li></ul>|
19+
|getAll|Return the proxy information in array.|
20+
|getProxyType|Return the proxy type. Please visit <a href="https://www.ip2location.com/databases/px4-ip-proxytype-country-region-city-isp" target="_blank">IP2Location</a> for the list of proxy types supported|
21+
|getCountryShort|Return the ISO3166-1 country code (2-digits) of the proxy.|
22+
|getCountryLong|Return the ISO3166-1 country name of the proxy.|
23+
|getRegion|Return the ISO3166-2 region name of the proxy. Please visit <a href="https://www.ip2location.com/free/iso3166-2" target="_blank">ISO3166-2 Subdivision Code</a> for the information of ISO3166-2 supported|
24+
|getCity|Return the city name of the proxy.|
25+
|getISP|Return the ISP name of the proxy.|
26+
827
## Usage
928

1029
Open and read IP2Proxy binary database. There are 3 modes:

0 commit comments

Comments
 (0)