|
1 | | -IP2Location CakePHP Plugin |
2 | | -========================== |
3 | | -IP2Location CakePHP plugin enables the user to find the country, region, city, coordinates, zip code, |
4 | | -time zone, ISP, domain name, connection type, area code, weather, MCC, MNC, mobile brand name, elevation |
5 | | -and usage type that any IP address or hostname originates from. It has been optimized for speed and memory |
6 | | -utilization. Developers can use the API to query all IP2Location BIN databases for applications |
7 | | -written using CakePHP. |
| 1 | +# IP2Location CakePHP Plugin |
| 2 | +IP2Location CakePHP plugin enables the user to find the country, region, city, coordinates, zip code, time zone, ISP, domain name, connection type, area code, weather, MCC, MNC, mobile brand name, elevation and usage type that any IP address or hostname originates from. It has been optimized for speed and memory utilization. Developers can use the API to query all IP2Location BIN databases for applications written using CakePHP. |
8 | 3 |
|
9 | 4 |
|
10 | | -INSTALLATION |
11 | | ------------- |
| 5 | +## INSTALLATION |
| 6 | +### For CakePHP 2.x |
12 | 7 |
|
13 | | -1. Copy the IP2Location folder to app/Plugin. |
14 | | -2. Add "CakePlugin::load('IP2Location');" to the last line of "app/Config/bootstrap.php" |
| 8 | +1. Copy the IP2Location folder to *app/Plugin*. |
| 9 | +2. Add `CakePlugin::load('IP2Location');` to the last line of *app/Config/bootstrap.php*. |
15 | 10 | 3. Download IP2Location BIN database |
16 | | - - IP2Location free LITE database at http://lite.ip2location.com |
17 | | - - IP2Location commercial database at http://www.ip2location.com |
18 | | -4. Unzip and copy the BIN file into app/Plugin/IP2Location/data folder. |
| 11 | + - IP2Location free LITE database at http://lite.ip2location.com |
| 12 | + - IP2Location commercial database at http://www.ip2location.com |
| 13 | +4. Unzip and copy the BIN file into *app/Plugin/IP2Location/data* folder. |
19 | 14 | 5. Rename the BIN file to IP2LOCATION.BIN. |
20 | 15 |
|
21 | | -Note: The plugin has included an old BIN database for your testing and development purpose. |
| 16 | +### For CakePHP 3.x |
| 17 | + |
| 18 | +1. Copy the IP2Location folder to *plugins* folder. |
| 19 | +2. Download IP2Location BIN database |
| 20 | + - IP2Location free LITE database at http://lite.ip2location.com |
| 21 | + - IP2Location commercial database at http://www.ip2location.com |
| 22 | +3. Unzip and copy the BIN file into *plugins/IP2Location/data* folder. |
| 23 | +4. Rename the BIN file to IP2LOCATION.BIN. |
| 24 | +5. Add `use Cake\Core\Configure;` to line20 of *plugins/IP2Location/Model/IP2LocationCore.php*. |
| 25 | + |
| 26 | +**Note:** The plugin has included an old BIN database for your testing and development purpose. |
22 | 27 | You may want to download a latest copy of BIN database as the URL stated above. |
23 | 28 | The BIN database refers to the binary file ended with .BIN extension, but not the CSV format. |
24 | 29 | Please select the right package for download. |
25 | 30 |
|
26 | | -USAGE |
27 | | ---------------- |
| 31 | +## USAGE |
| 32 | +``` |
| 33 | +if (Configure::version() < '3') { |
| 34 | + App::uses('IP2LocationCore', 'IP2Location.Model'); |
| 35 | +} |
| 36 | +else { |
| 37 | + require_once(ROOT . DS . 'plugins' . DS . 'IP2Location' . DS . 'Model' . DS . 'IP2LocationCore.php'); |
| 38 | +} |
28 | 39 |
|
29 | | -App::uses('IP2LocationCore', 'IP2Location.Model'); |
30 | 40 | $IP2Location = new IP2LocationCore(); |
31 | 41 | $record = $IP2Location->get($this->request->clientIp()); |
32 | 42 |
|
33 | | -echo 'IP Address: ' . $record['ipAddress'] . '<br />'; |
34 | | -echo 'IP Number: ' . $record['ipNumber'] . '<br />'; |
35 | | -echo 'ISO Country Code: ' . $record['countryCode'] . '<br />'; |
36 | | -echo 'Country Name: ' . $record['countryName'] . '<br />'; |
37 | | -echo 'Region Name: ' . $record['regionName'] . '<br />'; |
38 | | -echo 'City Name: ' . $record['cityName'] . '<br />'; |
39 | | -echo 'Latitude: ' . $record['latitude'] . '<br />'; |
40 | | -echo 'Longitude: ' . $record['longitude'] . '<br />'; |
41 | | -echo 'ZIP Code: ' . $record['zipCode'] . '<br />'; |
42 | | -echo 'Time Zone: ' . $record['timeZone'] . '<br />'; |
43 | | -echo 'ISP Name: ' . $record['isp'] . '<br />'; |
44 | | -echo 'Domain Name: ' . $record['domainName'] . '<br />'; |
45 | | -echo 'Net Speed: ' . $record['netSpeed'] . '<br />'; |
46 | | -echo 'IDD Code: ' . $record['iddCode'] . '<br />'; |
47 | | -echo 'Area Code: ' . $record['areaCode'] . '<br />'; |
48 | | -echo 'Weather Station Code: ' . $record['weatherStationCode'] . '<br />'; |
49 | | -echo 'Weather Station Name: ' . $record['weatherStationName'] . '<br />'; |
50 | | -echo 'MCC: ' . $record['mcc'] . '<br />'; |
51 | | -echo 'MNC: ' . $record['mnc'] . '<br />'; |
52 | | -echo 'Mobile Carrier Name: ' . $record['mobileCarrierName'] . '<br />'; |
53 | | -echo 'Elevation: ' . $record['elevation'] . '<br />'; |
54 | | -echo 'Usage Type: ' . $record['usageType'] . '<br />'; |
55 | | - |
56 | | - |
57 | | -SUPPORT |
58 | | -------- |
| 43 | +echo 'IP Address: ' . $record['ipAddress'] . '<br>'; |
| 44 | +echo 'IP Number: ' . $record['ipNumber'] . '<br>'; |
| 45 | +echo 'ISO Country Code: ' . $record['countryCode'] . '<br>'; |
| 46 | +echo 'Country Name: ' . $record['countryName'] . '<br>'; |
| 47 | +echo 'Region Name: ' . $record['regionName'] . '<br>'; |
| 48 | +echo 'City Name: ' . $record['cityName'] . '<br>'; |
| 49 | +echo 'Latitude: ' . $record['latitude'] . '<br>'; |
| 50 | +echo 'Longitude: ' . $record['longitude'] . '<br>'; |
| 51 | +echo 'ZIP Code: ' . $record['zipCode'] . '<br>'; |
| 52 | +echo 'Time Zone: ' . $record['timeZone'] . '<br>'; |
| 53 | +echo 'ISP Name: ' . $record['isp'] . '<br>'; |
| 54 | +echo 'Domain Name: ' . $record['domainName'] . '<br>'; |
| 55 | +echo 'Net Speed: ' . $record['netSpeed'] . '<br>'; |
| 56 | +echo 'IDD Code: ' . $record['iddCode'] . '<br>'; |
| 57 | +echo 'Area Code: ' . $record['areaCode'] . '<br>'; |
| 58 | +echo 'Weather Station Code: ' . $record['weatherStationCode'] . '<br>'; |
| 59 | +echo 'Weather Station Name: ' . $record['weatherStationName'] . '<br>'; |
| 60 | +echo 'MCC: ' . $record['mcc'] . '<br>'; |
| 61 | +echo 'MNC: ' . $record['mnc'] . '<br>'; |
| 62 | +echo 'Mobile Carrier Name: ' . $record['mobileCarrierName'] . '<br>'; |
| 63 | +echo 'Elevation: ' . $record['elevation'] . '<br>'; |
| 64 | +echo 'Usage Type: ' . $record['usageType'] . '<br>'; |
| 65 | +``` |
| 66 | + |
| 67 | +## SUPPORT |
59 | 68 | |
60 | 69 | Website: http://www.ip2location.com |
0 commit comments