Class: Net_GeoIP

To use this class you must have a [binary version] GeoIP database. There is a free GeoIP country database which can be obtained from Maxmind: http://www.maxmind.com/app/geoip_country

SIMPLE USE

Create an instance:

1     $geoip = Net_GeoIP::getInstance('/path/to/geoipdb.dat', Net_GeoIP::SHARED_MEMORY);

Depending on which database you are using (free, or one of paid versions) you must use appropriate lookup method:

1     // for free country db:
2      $country_name = $geoip->lookupCountryName($_SERVER['REMOTE_ADDR']);
3      $country_code = $geoip->lookupCountryCode($_SERVER['REMOTE_ADDR']);
4     
5      // for [non-free] region db:
6      list($ctry_code, $region) = $geoip->lookupRegion($_SERVER['REMOTE_ADDR']);
7     
8      // for [non-free] city db:
9      $location = $geoip->lookupLocation($_SERVER['REMOTE_ADDR']);
10     print "city: " . $location->city . ", " . $location->region;
11     print "lat: " . $location->latitude . ", long: " . $location->longitude;
12    
13     // for organization or ISP db:
14     $org_or_isp_name = $geoip->lookupOrg($_SERVER['REMOTE_ADDR']);

MULTIPLE INSTANCES

You can have several instances of this class, one for each database file you are using. You should use the static getInstance() singleton method to save on overhead of setting up database segments. Note that only one instance is stored per filename, and any flags will be ignored if an instance already exists for the specifiedfilename.

Special note on using SHARED_MEMORY flag

If you are using SHARED_MEMORY (shmop) you can only use SHARED_MEMORY for one (1) instance (i.e. for one database). Any subsequent attempts to instantiate using SHARED_MEMORY will read the same shared memory block already initialized, and therefore will cause problems since the expected database format won't match the database in the shared memory block.

Note that there is no easy way to flag "nice errors" to prevent attempts to create new instances using SHARED_MEMORY flag and it is also not posible (in a safe way) to allow new instances to overwrite the shared memory block.

In short, is you are using multiple databses, use the SHARED_MEMORY flag with care.

LOOKUPS ON HOSTNAMES

Note that this PHP API does NOT support lookups on hostnames. This is so that the public API can be kept simple and so that the lookup functions don't need to try name lookups if IP lookup fails (which would be the only way to keep the API simple and support name-based lookups).

If you do not know the IP address, you can convert an name to IP very simply using PHP native functions or other libraries:

1     $geoip->lookupCountryName(gethostbyname('www.sunset.se'));

Or, if you don't know whether an address is a name or ip address, use application-level logic:

1     if (ip2long($ip_or_name) === false) {
2        $ip = gethostbyname($ip_or_name);
3      } else {
4        $ip = $ip_or_name;
5      }
6      $ctry = $geoip->lookupCountryName($ip);

close   [line 514]

getInstance   [line 361]

1     // create new instance with memory_cache enabled
2      $geoip = Net_GeoIP::getInstance('C:\mydb.dat', Net_GeoIP::MEMORY_CACHE);
3      ....
4     
5      // later in code, request instance with no flags specified.
6      $geoip = Net_GeoIP::getInstance('C:\mydb.dat');
7     
8      // Normally this means no MEMORY_CACHE but since an instance
9      // with memory cache enabled has already been created for 'C:\mydb.dat', the
10     // existing instance (with memory cache) will be returned.

getOrg   [line 679]

getRecord   [line 739]

getRegion   [line 701]

loadSharedMemory   [line 408]

lookupCountryCode   [line 556]

lookupCountryId   [line 536]

lookupCountryName   [line 569]

lookupLocation   [line 661]

lookupOrg   [line 623]

lookupRegion   [line 642]

open   [line 375]

seekCountry   [line 581]

setupSegments   [line 433]