lostlink / laravel-geoip
Geoip Wrapper with Laravel Support
Requires
- php: ^8.0 || ^8.1
- geoip2/geoip2: ^v2.12
- guzzlehttp/guzzle: ^7
- illuminate/console: ^v8 || ^v9
- illuminate/support: ^v8 || ^v9
Requires (Dev)
- friendsofphp/php-cs-fixer: ^v3
- mockery/mockery: ^1.4
- phpunit/phpunit: ^9
README
Geoip Wrapper with Laravel Support
Supported Drivers (Services)
Requirements
- PHP >= 7.2
Installation
Install via composer
composer require lostlink/laravel-geoip
Laravel
There is a Laravel service provider and facade available.
Add the following to the providers
array in your config/app.php
LostLink\GeoIP\GeoIPServiceProvider::class
Next add the following to the aliases
array in your config/app.php
'GeoIP' => LostLink\GeoIP\Facades\GeoIP::class
Next run php artisan vendor:publish --provider="LostLink\GeoIP\GeoIPServiceProvider" --tag="config"
to publish the config file.
Using an older version of PHP / Laravel?
If you are on a PHP version below 7.2 or a Laravel version below 5.8 just use an older version of this package.
Usage
The geoip class takes a config array as the first parameter or defaults to using the ip-api
driver.
Example:
<?php use LostLink\GeoIP\GeoIP $geoip = new GeoIP(); $lat = $geoip->getLatitude(); // 51.5141 $lon = $geoip->getLongitude(); // -3.1969
IPStack
To use the ipstack as the driver set the config.
Example:
$config = [ 'driver' => 'ipstack', 'ipstack' => [ 'key' => 'YOUR IPSTACK KEY', 'secure' => true, // (optional) use https ], ];
IP-API
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', ], ];
Maxmind Database
To use Maxmind database as the driver you can set the options in your config.
Database Example:
$config = [ 'driver' => 'maxmind_database', 'maxmind_database' => [ 'database' => '/path/to/database.mmdb', ], ];
Maxmind Api
To use Maxmind api as the driver you can set the options in your config.
Web API Example:
$config = [ 'driver' => 'maxmind_api', 'maxmind_api' => [ 'user_id' => 'YOUR MAXMIND USER ID', 'license_key' => 'YOUR MAXMIND LICENSE KEY' ], ];
Telize
To use telize as the driver set the config, and your api key.
Example:
$config = [ 'driver' => 'telize', 'telize' => [ 'key' => 'YOUR TELIZE KEY', ], ];
Laravel
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.
Available Methods
GeoIP will try to determine 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
Get raw geo information
$geoip->getRaw(); // different drivers will return different data types // Laravel GeoIP::getRaw(); // different drivers will return different data types
Update Database
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
. As of 30th December 2019, Maxmind requires users to create an account and use a license key to download the databases.
<?php use LostLink\GeoIP\GeoIPUpdater $config = [ 'driver' => 'maxmind_database', 'maxmind_database' => [ 'database' => '/path/to/database.mmdb', 'license_key' => 'YOUR MAXMIND LICENSE KEY' ], ]; (new GeoIPUpdater($config))->update();
Laravel
Once you have registered the service provider (supports auto discovery), you can use the command php artisan geoip:update
Services
IPStack
IPStack offers a JSON IP and GeoIP REST API allowing to get a visitor IP address and to query location information from any IP address.
IP-API
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.
Maxmind
You can use the free database from maxmind (license_key required) or their web api service. You can signup and get a free license code here.
Telize
Telize offers a JSON IP and GeoIP REST API allowing to get a visitor IP address and to query location information from any IP address. It outputs JSON-encoded IP geolocation data, and supports both Cross-origin resource sharing (CORS) and JSONP.