Changed public interfaces.

Author: ip2location

README.md

@@ -23,7 +23,7 @@ $db = new \IP2Proxy\Database('./samples/IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CIT
 To start lookup result from database, use the following codes:
 
 ```
-$records = $db->lookup('1.0.241.135', \IP2Proxy\Database::ALL);
+$records = $db->getAll('1.0.241.135');
 ```
 
 Results are returned in array.

class.IP2Proxy.php

@@ -32,7 +32,7 @@ class Database {
    *
    * @var string
    */
-  const VERSION = '1.0.0';
+  const VERSION = '1.1.0';
 
   //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
   //  Error field constants  ///////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -1147,22 +1147,12 @@ private function binSearch($version, $ipNumber) {
   //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
   /**
-   * Get the database's compilation date as a string of the form 'YYYY-MM-DD'
-   *
-   * @access public
-   * @return string
-   */
-  public function getDate() {
-    return $this->date;
-  }
-
-  /**
-   * Get the database's type (1-4)
+   * Get the database's package (1-4)
    *
    * @access public
    * @return int
    */
-  public function getType() {
+  public function getPackageVersion() {
     return $this->type + 1;
   }
 
@@ -1203,6 +1193,62 @@ public function getDatabaseVersion() {
     return $this->year . '.' . $this->month . '.' . $this->day;
   }
 
+  /**
+   *  Return -1, 0, 1, 2
+  */
+  public function isProxy($ip) {
+    return self::lookup($ip, self::IS_PROXY);
+  }
+
+  /*
+   * Return string
+  */
+  public function getCountryShort($ip) {
+    return self::lookup($ip, self::COUNTRY_CODE);
+  }
+
+  /*
+   * Return string
+  */
+  public function getCountryLong($ip) {
+    return self::lookup($ip, self::COUNTRY_NAME);
+  }
+
+  /*
+   * Return string
+  */
+  public function getRegion($ip) {
+    return self::lookup($ip, self::REGION_NAME);
+  }
+
+  /*
+   * Return string
+  */
+  public function getCity($ip) {
+    return self::lookup($ip, self::CITY_NAME);
+  }
+
+  /*
+   * Return string
+  */
+  public function getISP($ip) {
+    return self::lookup($ip, self::ISP);
+  }
+
+  /*
+   * Return string
+  */
+  public function getProxyType($ip) {
+    return self::lookup($ip, self::PROXY_TYPE);
+  }
+
+  /*
+   * Return array
+  */
+  public function getAll($ip) {
+    return self::lookup($ip, self::ALL);
+  }
+
   /**
    * This function will look the given IP address up in the database and return the result(s) asked for
    *
@@ -1211,13 +1257,13 @@ public function getDatabaseVersion() {
    * array whith the returned singular field names as keys and their corresponding
    * values is returned.
    *
-   * @access public
+   * @access protected
    * @param string $ip  IP address to look up
    * @param int|array $fields  Field(s) to return
    * @param boolean $asNamed  Whether to return an associative array instead
    * @return mixed|array|boolean
    */
-  public function lookup($ip, $fields = null, $asNamed = true) {
+  protected function lookup($ip, $fields = null, $asNamed = true) {
     // extract IP version and number
     list($ipVersion, $ipNumber) = self::ipVersionAndNumber($ip);
     // perform the binary search proper (if the IP address was invalid, binSearch will return false)

example.php

@@ -2,15 +2,30 @@
 require 'class.IP2Proxy.php';
 
 $db = new \IP2Proxy\Database('./samples/IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP.SAMPLE.BIN', \IP2Proxy\Database::FILE_IO);
-$records = $db->lookup('1.0.241.135', \IP2Proxy\Database::ALL);
-
-echo '<p><strong>IP Address: </strong>' . $records['ipAddress'] . '</p>';
-echo '<p><strong>IP Number: </strong>' . $records['ipNumber'] . '</p>';
-echo '<p><strong>IP Version: </strong>' . $records['ipVersion'] . '</p>';
-echo '<p><strong>Country Code: </strong>' . $records['countryCode'] . '</p>';
-echo '<p><strong>Country: </strong>' . $records['countryName'] . '</p>';
-echo '<p><strong>State: </strong>' . $records['regionName'] . '</p>';
-echo '<p><strong>City: </strong>' . $records['cityName'] . '</p>';
-echo '<p><strong>Proxy Type: </strong>' . $records['proxyType'] . '</p>';
-echo '<p><strong>Is Proxy: </strong>' . $records['isProxy'] . '</p>';
-echo '<p><strong>ISP: </strong>' . $records['isp'] . '</p>';
+
+$countryCode = $db->getCountryShort('1.0.241.135');
+echo '<p><strong>Country Code: </strong>' . $countryCode . '</p>';
+
+$countryName = $db->getCountryLong('1.0.241.135');
+echo '<p><strong>Country: </strong>' . $countryName . '</p>';
+
+$regionName = $db->getRegion('1.0.241.135');
+echo '<p><strong>Region: </strong>' . $regionName . '</p>';
+
+$cityName = $db->getCity('1.0.241.135');
+echo '<p><strong>City: </strong>' . $cityName . '</p>';
+
+$isp = $db->getISP('1.0.241.135');
+echo '<p><strong>ISP: </strong>' . $isp . '</p>';
+
+$proxyType = $db->getProxyType('1.0.241.135');
+echo '<p><strong>Proxy Type: </strong>' . $proxyType . '</p>';
+
+$isProxy = $db->isProxy('1.0.241.135');
+echo '<p><strong>Is Proxy: </strong>' . $isProxy . '</p>';
+
+$records = $db->getAll('1.0.241.135');
+
+echo '<pre>';
+print_r($records);
+echo '</pre>';