chrislim2888/IP2Location-PHP-Module chrislim2888/IP2Location-PHP-Module

  • Stars
    star
    189
  • Rank 203,916 (Top 5 %)
  • Language
    PHP
  • License
    MIT License
  • Created over 11 years ago
  • Updated 3 months ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
chrislim2888/IP2Location-PHP-Module
github

chrislim2888

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

This module is a PHP module that enables the user to find the country, region, city, coordinates, zip code, ISP, domain name, timezone, connection speed, IDD code, area code, weather station code, weather station name, mobile, usage types, address type, IAB category, etc that any IP address or host name originates from.

IP2Location (PHP Module)

Latest Stable Version Total Downloads

This is the official release maintained by IP2Location.com

This PHP module provides fast lookup of country, region, district, city, latitude, longitude, ZIP code, time zone, ISP, domain name, connection speed, IDD code, area code, weather station code, weather station name, MNC, MCC, mobile brand, elevation, usage type, address type, IAB category and ASN from IP address by using IP2Location database. This module uses a file based database available at IP2Location.com.

This module can be used in many types of projects such as:

  1. select the geographically closest mirror
  2. analyze your web server logs to determine the countries of your visitors
  3. credit card fraud detection
  4. software export controls
  5. display native language and currency
  6. prevent password sharing and abuse of service
  7. geotargeting in advertisement

Free IP2Location LITE and commerical databases are available for download.

Monthly update is available for both IP2Location LITE and commercial database.

KEY FEATURES

  1. Support both IPv4 and IPv6 with ease. If you would like to enable IPv6 support, you just need to replace your BIN file with IPv6 version. That's it, and no code modification needed.
  2. Extensible. If you require different granularity of IP information, you can visit IP2Location.com to download the relevant BIN file, and the information will made ready for you.
  3. Comprehensive Information. There are more than 13 types of information that you can retrieve from an IP address. Please visit IP2Location.com for details.

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.

USAGE

You can check the example.php file to learn more about usage.

Database Class

Below is the description of the functions available in the Database class.

Function Name Description
Constructor Expect 2 input parameters:
  1. Full path of IP2Location BIN data file.
  2. File Open Mode
    • SHARED_MEMORY
    • MEMORY_CACHE
    • FILE_IO
For SHARED_MEMORY and MEMORY_CACHE, it will require your server to have sufficient memory to hold the BIN data, otherwise it will raise the errors during the object initialization.
string getDate() Return the database's compilation date as a string of the form 'YYYY-MM-DD'
string getType() Return the database's type, 1 to 26 respectively for DB1 to DB26. Please visit https://www.ip2location.com/databases for details.
string getModuleVersion() Return the version of module
string getDatabaseVersion() Return the version of database
array lookup($ip) Return the IP information in array. Below is the information returned:
  • ipNumber
  • ipVersion
  • ipAddress
  • countryCode
  • countryName
  • regionName
  • cityName
  • latitude
  • longitude
  • areaCode
  • iddCode
  • weatherStationCode
  • weatherStationName
  • mcc
  • mnc
  • mobileCarrierName
  • usageType
  • elevation
  • netSpeed
  • timeZone
  • zipCode
  • domainName
  • isp
  • addressType
  • category
  • district
  • asn
  • as
You can visit IP2Location for the description of each field. Note: although the above names are not exactly matched with the names given in this link, but they are self-described.
array getCidr($ip) Return an array of the complete IP list in CIDR format of the detected row record based on the given IP address.

WebService Class

Below is the description of the functions available in the WebService class.

Function Name Description
Constructor Expect 3 input parameters:
  1. IP2Location API Key.
  2. Package (WS1 - WS25)
  3. Use HTTPS or HTTP
array lookup($ip) Return the IP information in array.
  • country_code
  • country_name
  • region_name
  • city_name
  • latitude
  • longitude
  • zip_code
  • time_zone
  • isp
  • domain
  • net_speed
  • idd_code
  • area_code
  • weather_station_code
  • weather_station_name
  • mcc
  • mnc
  • mobile_brand
  • elevation
  • usage_type
  • address_type
  • category
  • continent
    • name
    • code
    • hemisphere
    • translations
  • country
    • name
    • alpha3_code
    • numeric_code
    • demonym
    • flag
    • capital
    • total_area
    • population
    • currency
      • code
      • name
      • symbol
    • language
      • code
      • name
    • idd_code
    • tld
    • translations
  • region
    • name
    • code
    • translations
  • city
    • name
    • translations
  • geotargeting
    • metro
  • country_groupings
  • time_zone_info
    • olson
    • current_time
    • gmt_offset
    • is_dst
    • sunrise
    • sunset
    int getCredit() Return remaining credit of the web service account.

    IpTools Class

    Below is the description of the functions available in the IpTools class.

    Function Name Description
    bool isIpv4($ip) Return either true or false. Verify if a string is a valid IPv4 address.
    bool isIpv6($ip) Return either true or false. Verify if a string is a valid IPv6 address.
    mixed ipv4ToDecimal($ip) Translate IPv4 address from dotted-decimal address to decimal format. Return null on error.
    mixed decimalToIpv4($number) Translate IPv4 address from decimal number to dotted-decimal address. Return null on error.
    mixed ipv6ToDecimal($ip) Translate IPv6 address from hexadecimal address to decimal format. Return null on error.
    mixed decimalToIpv6($number) Translate IPv6 address from decimal number into hexadecimal address. Return null on error.
    array ipv4ToCidr($ipFrom, $ipTo) Convert IPv4 range into a list of IPv4 CIDR notation.
    array cidrToIpv4($cidr) Convert IPv4 CIDR notation into a list of IPv4 addresses.
    array ipv6ToCidr($ipFrom, $ipTo) Convert IPv6 range into a list of IPv6 CIDR notation.
    array cidrToIpv6($cidr) Convert IPv6 CIDR notation into a list of IPv6 addresses.
    string compressIpv6($ipv6) Compress a IPv6 to shorten the length.
    string expandIpv6($ipv6) Expand a shorten IPv6 to full length.
    string getVisitorIp() Return the real IP address of the visitor. If an array of $ipData is supplied, it will return the list of IP address data found.

    Country Class

    Below is the description of the functions available in the Country class.

    Function Name Description
    Constructor Expect a IP2Location Country Information CSV file. This database is free for download at https://www.ip2location.com/free/country-information
    array getCountryInfo($countryCode) Provide a ISO 3166 country code to get the country information in array. Will return a full list of countries information if country code not provided. Below is the information returned:
    • country_code
    • country_alpha3_code
    • country_numeric_code
    • capital
    • country_demonym
    • total_area
    • population
    • idd_code
    • currency_code
    • currency_name
    • currency_symbol
    • lang_code
    • lang_name
    • cctld

    Region Class

    Below is the description of the functions available in the Region class.

    Function Name Description
    Constructor Expect a IP2Location ISO 3166-2 Subdivision Code CSV file. This database is free for download at https://www.ip2location.com/free/iso3166-2
    string getRegionCode($countryCode, $regionName) Provide a ISO 3166 country code and the region name to get ISO 3166-2 subdivision code for the region.

    DEPENDENCIES

    This library requires IP2Location BIN data file to function. You may download the BIN data file at

    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.

    You can also sign up for IP2Location Web Service to lookup by IP2Location API.

    BIN DOWNLOADER SCRIPT

    php ip2location_bin_download.php --token DOWNLOAD_TOKEN --file DATABASE_CODE -y

    The command above will download the DATABASE_CODE BIN file and unzip the file into data folder.

    Parameters Description
    token Download token. You can get your token at your IP2Location Account Area at the Download page.
    file Database package. (DB1BIN...DB26BIN, DB1BINIPV6...DB26BINIPV6, DB1LITEBIN...DB11LITEBIN or DB1LITEBINIPV6...DB11LITEBINIPV6) You may login to your IP2Location Account Area and get the package code (or download code) at the Download page.
    y Auto replace the current BIN file without acknowledgement.

    You can set the DOWNLOAD_TOKEN and DATABASE_CODE with values in the .env file (same path as ip2location_bin_download.php) and run the command php ip2location_bin_download.php for the download.

    IPv4 BIN vs IPv6 BIN

    • Use the IPv4 BIN file if you just need to query IPv4 addresses.
    • Use the IPv6 BIN file if you need to query BOTH IPv4 and IPv6 addresses.

    OTHER FRAMEWORK LIBRARY

    Below are the list of other framework library that you can install and use right away.

    COPYRIGHT AND LICENSE

    Copyright (C) 2005-2023 by IP2Location.com

    License under MIT

    More Repositories

    1

    IP2Location-Python

    This module is a Python Library that enables the user to find the country, region, city, coordinates, zip code, ISP, domain name, timezone, connection speed, IDD code, area code, weather station code, weather station name, mobile, usage types, address type and IAB category that any IP address or host name originates from.
    Python
    143
    star
    2

    IP2Location-C-Library

    IP2Location C library enables the user to find the country, region, city, coordinates, zip code, time zone, ISP, domain name, connection type, area code, weather station code, weather station name, mobile, usage types, etc that any IP address or hostname originates from.
    Shell
    57
    star
    3

    ip2location-nginx

    Nginx module that allows user to lookup for geolocation information using IP2Location database.
    C
    34
    star
    4

    IP2Location-PECL-Extension

    This PECL extension allows you to find the location of an IP address - country, region or state, city, latitude and longitude, US ZIP code, time zone, Internet Service Provider (ISP) or company name, domain name, net speed, area code, weather station code, weather station name, mobile country code (MCC), mobile network code (MNC) and carrier brand, elevation, usage type, address type and IAB category.
    C
    9
    star
    5

    fraudlabspro

    Fraud Prevention API to screen transaction order, e.g, credit card order, for online fraud.
    PHP
    7
    star
    6

    ip2location-pascal

    IP2Location Pascal/Delphi Library that enables the user to find the country, region, city, coordinates, zip code, ISP, domain name, timezone, connection speed, IDD code, area code, weather station code, weather station name, mobile, usage types, etc that any IP address or host name originates from.
    Pascal
    7
    star
    7

    IP2Location-Cocoa-Library

    This is a Cocoa library that enables the user to find the country, region, city, coordinates, zip code, time zone, ISP, domain name, connection type, area code, weather station name, mobile, usage types, etc that any IP address or hostname originates from.
    C
    3
    star
    8

    IP2Location-Apache-Module

    This is an IP2Location Apache Module that enables the user to identify the country, region, city, latitude, longitude, zip code, time zone, ISP, domain name, connection type, area code, weather station name, mobile, usage types, address type and IAB category by IP address.
    C
    3
    star
    9

    Geo-IP2Location

    Release history of Geo-IP2Location
    C
    1
    star
    10

    ip2location

    Get IP address information from IP2Location BIN data file
    C
    1
    star
    11

    IP2Location-World-SVG-Map

    HTML
    1
    star