Geoip Wrapper with Laravel 4 & 5 Support
Supported Drivers (Services)
- PHP >= 5.4
Install via composer - edit your composer.json
to require the package.
"require": {
"pulkitjalan/geoip": "2.*"
}
Then run composer update
in your terminal to pull it in.
There is a Laravel service provider and facade available.
Add the following to the providers
array in your config/app.php
'PulkitJalan\GeoIP\GeoIPServiceProvider'
Next add the following to the aliases
array in your config/app.php
'GeoIP' => 'PulkitJalan\GeoIP\Facades\GeoIP'
Next run php artisan vendor:publish --provider="pulkitjalan\geoip\GeoIPServiceProvider" --tag="config"
to publish the config file.
Checkout the 1.0 branch
The geoip class takes a config array as the first parameter or defaults to using the ip-api
driver.
Example:
<?php
use PulkitJalan\GeoIP\GeoIP
$geoip = new GeoIP();
$lat = $geoip->getLatitude(); // 51.5141
$lon = $geoip->getLongitude(); // -3.1969
To use the ip-api pro service you can set the options in your config.
Pro Example:
$config = [
'driver' => 'ip-api',
'ip-api' => [
'key' => 'YOUR IP-API KEY',
// optionally set secure (https) connection (default: false)
'secure' => true
],
];
To use the telize as the driver set the config, can also use https instead by setting secure
to true
.
Secure Example:
$config = [
'driver' => 'telize',
'telize' => [
// optionally set secure (https) connection (default: false)
'secure' => true
],
];
Maxmind support the database type and also web api type.
Database Example:
$config = [
'driver' => 'maxmind',
'maxmind' => [
'database' => '/path/to/database.mmdb',
],
];
Web API Example:
$config = [
'driver' => 'maxmind',
'maxmind' => [
'user_id' => 'YOUR MAXMIND USER ID',
'license_key' => 'YOUR MAXMIND LICENSE KEY'
],
];
To use this package in Laravel, simply update the config file in config/geoip.php
to get the same effect. The driver can be set using the GEOIP_DRIVER
env.
GeoIP will try to determin the ip using the following http headers: HTTP_CLIENT_IP
, HTTP_X_FORWARDED_FOR
, HTTP_X_FORWARDED
, HTTP_FORWARDED_FOR
, HTTP_FORWARDED
, REMOTE_ADDR
in this order. Optionally use the setIp
method to set it.
$geoip->setIp('127.0.0.1');
// Laravel
GeoIP::setIp('127.0.0.1');
There are a number of available methods to pull out the required information. All methods will return an empty string if data is unavailable.
Get latitude
$geoip->getLatitude();
// Laravel
GeoIP::getLatitude();
Get longitude
$geoip->getLongitude();
// Laravel
GeoIP::getLongitude();
Get city
$geoip->getCity();
// Laravel
GeoIP::getCity();
Get country
$geoip->getCountry();
// Laravel
GeoIP::getCountry();
Get country code
$geoip->getCountryCode();
// Laravel
GeoIP::getCountryCode();
Get region
$geoip->getRegion();
// Laravel
GeoIP::getRegion();
Get region code
$geoip->getRegionCode();
// Laravel
GeoIP::getRegionCode();
Get postal code
$geoip->getPostalCode();
// Laravel
GeoIP::getPostalCode();
Get timezone
$geoip->getTimezone();
// Laravel
GeoIP::getTimezone();
Get isp (not supported on all drivers)
$geoip->getIsp();
// Laravel
GeoIP::getIsp();
Get all geo information
$geoip->get(); // returns array
// Laravel
GeoIP::get(); // returns array
There is an update command available to help with updating and installing a local geoip database. The following will download and install/update the database file to /path/to/database.mmdb
.
<?php
use PulkitJalan\GeoIP\GeoIPUpdater
$config = [
'driver' => 'maxmind',
'maxmind' => [
'database' => '/path/to/database.mmdb',
],
];
$geoipUpdater = new GeoIPUpdater($config);
$geoipUpdater->update();
Once you have registered the service provider, you can use the command php artasin geoip:update
IP-API is a free (or paid) service that can also be used instead of the database file or the paid maxmind service. They do have some limitations on the free service so please have a look at the docs first.
Telize is a free service that can be used as an alternative. It currently has no limitations.
You can use the free database from maxmind or their web api service. You can download the free database service here or enter your user id
and license key
in the config.