Server : Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.4.20 System : Linux st2.domain.com 3.10.0-1127.10.1.el7.x86_64 #1 SMP Wed Jun 3 14:28:03 UTC 2020 x86_64 User : apache ( 48) PHP Version : 7.4.20 Disable Function : NONE Directory : /var/www/html/thietkeweb2/vendor/ip2location/ip2location-php/docs/source/ |
# Quickstart
## Dependencies
This library requires IP2Location BIN database to function. You may
download the BIN database at
- IP2Location LITE BIN Data (Free): <https://lite.ip2location.com>
- IP2Location Commercial BIN Data (Comprehensive):
<https://www.ip2location.com>
:::{note}
An outdated BIN database was provided in the databases folder for your testing. You are recommended to visit the above links to download the latest BIN database.
:::
## Requirements
1. Python 3.5 and above.
## Installation
Install this package using **composer** as below:
```
composer require ip2location/ip2location-php
```
To test this installation, please browse *examples/example.php* using web browser.
## Sample Codes
### Query geolocation information from BIN database
You can query the geolocation information from the IP2Location BIN
database as below:
``` php
<?php
require 'vendor/autoload.php';
/*
Cache whole database into system memory and share among other scripts & websites
WARNING: Please make sure your system have sufficient RAM to enable this feature
*/
//$db = new \IP2Location\Database('./data/IP2LOCATION-LITE-DB1.BIN', \IP2Location\Database::SHARED_MEMORY);
/*
Cache the database into memory to accelerate lookup speed
WARNING: Please make sure your system have sufficient RAM to enable this feature
*/
// $db = new \IP2Location\Database('./data/IP2LOCATION-LITE-DB1.BIN', \IP2Location\Database::MEMORY_CACHE);
// Default file I/O lookup
$db = new \IP2Location\Database('./data/IP2LOCATION-LITE-DB1.BIN', \IP2Location\Database::FILE_IO);
$records = $db->lookup('8.8.8.8', \IP2Location\Database::ALL);
echo $db->getDate();
echo '<pre>';
echo 'IP Number : ' . $records['ipNumber'] . "\n";
echo 'IP Version : ' . $records['ipVersion'] . "\n";
echo 'IP Address : ' . $records['ipAddress'] . "\n";
echo 'Country Code : ' . $records['countryCode'] . "\n";
echo 'Country Name : ' . $records['countryName'] . "\n";
echo 'Region Name : ' . $records['regionName'] . "\n";
echo 'City Name : ' . $records['cityName'] . "\n";
echo 'Latitude : ' . $records['latitude'] . "\n";
echo 'Longitude : ' . $records['longitude'] . "\n";
echo 'Area Code : ' . $records['areaCode'] . "\n";
echo 'IDD Code : ' . $records['iddCode'] . "\n";
echo 'Weather Station Code : ' . $records['weatherStationCode'] . "\n";
echo 'Weather Station Name : ' . $records['weatherStationName'] . "\n";
echo 'MCC : ' . $records['mcc'] . "\n";
echo 'MNC : ' . $records['mnc'] . "\n";
echo 'Mobile Carrier : ' . $records['mobileCarrierName'] . "\n";
echo 'Usage Type : ' . $records['usageType'] . "\n";
echo 'Elevation : ' . $records['elevation'] . "\n";
echo 'Net Speed : ' . $records['netSpeed'] . "\n";
echo 'Time Zone : ' . $records['timeZone'] . "\n";
echo 'ZIP Code : ' . $records['zipCode'] . "\n";
echo 'Domain Name : ' . $records['domainName'] . "\n";
echo 'ISP Name : ' . $records['isp'] . "\n";
echo 'Address Type : ' . $records['addressType'] . "\n";
echo 'Category : ' . $records['category'] . "\n";
echo 'District : ' . $records['district'] . "\n";
echo 'ASN : ' . $records['asn'] . "\n";
echo 'AS : ' . $records['as'] . "\n";
echo '</pre>';
?>
```
### Processing IP address using IP Tools class
You can manupulate IP address, IP number and CIDR as below:
``` php
<?php
require 'vendor/autoload.php';
$ipTools = new \IP2Location\IpTools();
// Validate IPv4 address
var_dump($ipTools->isIpv4('8.8.8.8'));
echo '<br>';
// Validate IPv6 address
var_dump($ipTools->isIpv6('2001:4860:4860::8888'));
echo '<br>';
// Convert IPv4 into decimal
echo $ipTools->ipv4ToDecimal('8.8.8.8');
echo '<br>';
// Convert IPv6 into decimal
echo $ipTools->ipv6ToDecimal('2001:4860:4860::8888');
echo '<br>';
// Convert decimal into IPv4 address
echo $ipTools->decimalToIpv4(134744072);
// Convert IPv4 range into CIDR
echo '<pre>';
print_r($ipTools->ipv4ToCidr('8.0.0.0', '8.255.255.255'));
echo '</pre>';
// Convert CIDR to IPv4 range
echo '<pre>';
print_r($ipTools->cidrToIpv4('8.0.0.0/8'));
echo '</pre>';
// Convert CIDR into IPv6 range
echo '<pre>';
print_r($ipTools->cidrToIpv6('2002::1234:abcd:ffff:c0a8:101/64'));
echo '</pre>';
// Convert IPv6 range into CIDR
echo '<pre>';
print_r($ipTools->ipv6ToCidr('2002:0000:0000:1234:abcd:ffff:c0a8:0000', '2002:0000:0000:1234:ffff:ffff:ffff:ffff'));
echo '</pre>';
// Compress IPv6
echo '<pre>';
print_r($ipTools->compressIpv6('2002:0000:0000:1234:FFFF:FFFF:FFFF:FFFF'));
echo '</pre>';
// Expand IPv6
echo '<pre>';
print_r($ipTools->expandIpv6('2002::1234:FFFF:FFFF:FFFF:FFFF'));
echo '</pre>';
echo '<br>';
// Convert decimal into IPv6 address
echo $ipTools->decimalToIpv6('42541956123769884636017138956568135816');
?>
```
### List down country information
You can query country information for a country from IP2Location Country
Information CSV file as below:
``` php
<?php
require 'vendor/autoload.php';
// List country information for US
$country = new \IP2Location\Country('./data/IP2LOCATION-COUNTRY-INFORMATION-BASIC.CSV');
echo '<pre>';
print_r($country->getCountryInfo('US'));
echo '</pre>';
?>
```
### List down region information
You can get the region code by country code and region name from
IP2Location ISO 3166-2 Subdivision Code CSV file as below:
``` php
<?php
require 'vendor/autoload.php';
// Get region code by country code and region
$region = new \IP2Location\Region('./data/IP2LOCATION-ISO3166-2.CSV');
echo $region->getRegionCode('US', 'California');
?>
```