Added supports for address type and category fields.

Author: ip2location

LICENSE.TXT

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 IP2Location.com
+Copyright (c) 2021 IP2Location.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -16,6 +16,8 @@ This module enables users to retrieve below geolocation information from an IP a
 * Weather Station Information
 * Elevation
 * Usage Type
+* Address Type
+* Category
 
 
 ## Installation
@@ -57,6 +59,8 @@ Below are the methods supported for BIN data file lookup.
     $mobileCarrierName = $ipl->getMobileCarrierName($ip);
     $elevation = $ipl->getElevation($ip);
     $usageType = $ipl->getUsageType($ip);
+    $addressType = $ipl->getAddressType($ip);
+    $category = $ipl->getCategory($ip);
 
 ### Web Service
 Use following codes in your application for get geolocation information.

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "ip2location/codeigniter-ip2location",
-    "description": "IP2Location library for CodeIgniter. Use IP2Location geolocation database to lookup 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.",
+    "description": "IP2Location library for CodeIgniter. Use IP2Location geolocation database to lookup the country, region, city, coordinates, zip code, time zone, ISP, domain name, connection type, area code, weather, MCC, MNC, mobile brand name, elevation, usage type, IP address type and IAB advertising category from IP address using IP2Location database.",
     "keywords": ["ip2location-bin-database", "geolocation-information", "codeigniter-ip2location", "ip-geolocation", "geolocation", "ip-lookup", "ip-address-database", "ip-database"],
     "homepage": "https://www.ip2location.com",
     "license": "MIT",

controllers/IP2Location_test.php

@@ -1,10 +1,12 @@
-<?php namespace App\Controllers;
-
-use App\Libraries\IP2Location_lib;
-
+<?php
 date_default_timezone_set('Etc/UTC');
 
-class IP2Location_test extends BaseController {
+class IP2Location_test extends CI_Controller {
+    function __construct() {
+        parent::__construct();
+        $this->load->library('ip2location_lib');
+    }
+
     public function index() {
         $ipl = new IP2Location_lib();
 

libraries/IP2Location_lib.php

@@ -1,4 +1,5 @@
-<?php namespace App\Libraries;
+<?php
+(defined('BASEPATH') || defined('SYSPATH')) or die('No direct access allowed.');
 
 // BIN Database Setting
 if(!defined('IP2LOCATION_DATABASE')) {
@@ -26,7 +27,10 @@
 	define('IP2LOCATION_LANGUAGE', 'en');
 }
 
-require_once('ip2location/IP2Location.php');
+require_once('ip2location/Country.php');
+require_once('ip2location/Database.php');
+require_once('ip2location/IpTools.php');
+require_once('ip2location/WebService.php');
 
 class IP2Location_lib {
 	private $database;
@@ -116,6 +120,14 @@ public function getUsageType($ip=NULL) {
 		return self::$ip2location->lookup(self::getIP($ip), \IP2Location\Database::USAGE_TYPE);
 	}
 
+	public function getAddressType($ip=NULL) {
+		return self::$ip2location->lookup(self::getIP($ip), \IP2Location\Database::ADDRESS_TYPE);
+	}
+
+	public function getCategory($ip=NULL) {
+		return self::$ip2location->lookup(self::getIP($ip), \IP2Location\Database::CATEGORY);
+	}
+
 	public function getWebService($ip=NULL) {
 		$ws = new \IP2Location\WebService(IP2LOCATION_API_KEY, IP2LOCATION_PACKAGE, IP2LOCATION_USESSL);
 		return $ws->lookup(self::getIP($ip), IP2LOCATION_ADDONS, IP2LOCATION_LANGUAGE);

libraries/ip2location/Country.php

@@ -0,0 +1,137 @@
+<?php
+
+namespace IP2Location;
+
+/**
+ * Country class.
+ */
+class Country
+{
+	/**
+	 * Unable to locate CSV file.
+	 *
+	 * @var int
+	 */
+	public const EXCEPTION_FILE_NOT_EXISTS = 10000;
+
+	/**
+	 * Invalid CSV file.
+	 *
+	 * @var int
+	 */
+	public const EXCEPTION_INVALID_CSV = 10001;
+
+	/**
+	 * Unable to read the CSV file.
+	 *
+	 * @var int
+	 */
+	public const EXCEPTION_UNABLE_TO_OPEN_CSV = 10002;
+
+	/**
+	 * No record found.
+	 *
+	 * @var int
+	 */
+	public const EXCEPTION_NO_RECORD = 10003;
+
+	/**
+	 * Fields from CSV.
+	 *
+	 * @var array
+	 */
+	protected $fields = [];
+
+	/**
+	 * Records from CSV.
+	 *
+	 * @var array
+	 */
+	protected $records = [];
+
+	/**
+	 * Constructor.
+	 *
+	 * @param string $csv Path to CSV file
+	 *
+	 * @throws \Exception
+	 */
+	public function __construct($csv)
+	{
+		if (!file_exists($csv)) {
+			throw new \Exception(__CLASS__ . ': The CSV file "' . $csv . '" is not found.', self::EXCEPTION_FILE_NOT_EXISTS);
+		}
+
+		$file = fopen($csv, 'r');
+
+		if (!$file) {
+			throw new \Exception(__CLASS__ . ': Unable to read "' . $csv . '".', self::EXCEPTION_UNABLE_TO_OPEN_CSV);
+		}
+
+		$line = 1;
+
+		while (!feof($file)) {
+			$data = fgetcsv($file);
+
+			if (!$data) {
+				++$line;
+				continue;
+			}
+
+			// Parse the CSV fields
+			if ($line == 1) {
+				if ($data[0] != 'country_code') {
+					throw new \Exception(__CLASS__ . ': Invalid country information CSV file.', self::EXCEPTION_INVALID_CSV);
+				}
+
+				$this->fields = $data;
+			} else {
+				$this->records[$data[0]] = $data;
+			}
+
+			++$line;
+		}
+	}
+
+	/**
+	 * Get the country information.
+	 *
+	 * @param string $countryCode The country ISO 3166 country code.
+	 *
+	 * @throws \Exception
+	 *
+	 * @return array
+	 */
+	public function getCountryInfo($countryCode = '')
+	{
+		if (empty($this->records)) {
+			throw new \Exception(__CLASS__ . ': No record available.', self::EXCEPTION_NO_RECORD);
+		}
+
+		$results = [];
+
+		if ($countryCode) {
+			if (!isset($this->records[$countryCode])) {
+				return [];
+			}
+
+			for ($i = 0; $i < \count($this->fields); ++$i) {
+				$results[$this->fields[$i]] = $this->records[$countryCode][$i];
+			}
+
+			return $results;
+		}
+
+		foreach ($this->records as $record) {
+			$data = [];
+
+			for ($i = 0; $i < \count($this->fields); ++$i) {
+				$data[$this->fields[$i]] = $record[$i];
+			}
+
+			$results[] = $data;
+		}
+
+		return $results;
+	}
+}