Location

Retrieve a users location from their IP address using external web services, or through a flat-file database hosted on your server.

Installation

Add Location to your composer.json file:

"stevebauman/location": "2.0.*"

Then run composer update on your project source.

Add the service provider in config/app.php:

Stevebauman\Location\LocationServiceProvider::class,

Add the alias in your config/app.php file:

'Location' => 'Stevebauman\Location\Facades\Location',

Publish the config file:

php artisan vendor:publish

Upgrading

If you're upgrading from v1.*, there's some changes to be aware of:

Location::dropdown() Removed
Location::lists() Removed
Location::is() Removed
Second parameter in Location::get() removed: Was Location::get($ip, $field), now Location::get($ip)
Location::getConfig() Removed
Stevebauman\Location\Drivers\DriverInterface has been removed
Configuration completely reworked, you will need to republish your configuration file

Usage

Retrieving a users location:

// Returns instance of Stevebauman\Location\Position

$position = Location::get();

Retrieving a users location with a specific IP address:

$position = Location::get('192.168.1.1');

Drivers

Available Drivers

Available drivers at the moment are:

Setting Up MaxMind

To setup MaxMind to retrieve the users location from your own server, download the database file here:

http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz

Extract the downloaded file, and place the GeoLite2-City.mmdb file into your database directory, and create the folder maxmind.

You should end up with a folder path of: my-laravel-app/database/maxmind/GeoLite2-City.mmdb.

Then, set your default driver to Stevebauman\Location\Drivers\MaxMind::class, and you're all set!

Note: Keep in mind, you'll need to update this file continuously to retrieve the most current information.

Fallback drivers

In the config file, you can specify as many fallback drivers as you wish. It's recommended to install the MaxMind database .mmdb file so your always retrieving some generic location information from the user.

If an exception occurs trying to grab a driver (such as a 404 error if the providers API changes), it will automatically use the next driver in line.

Creating your own drivers

To create your own driver, simply create a class in your application, and extend the abstract Driver:

namespace App\Location\Drivers;

use Illuminate\Support\Fluent;
use Stevebauman\Location\Position;
use Stevebauman\Location\Drivers\Driver;

class MyDriver extends Driver
{
    public function url()
    {
        return '';
    }
    
    protected function hydrate(Position $position, Fluent $location)
    {
        $position->countryCode = $location->country_code;
        
        return $position;
    }
    
    protected function process($ip)
    {
        try {
            $response = json_decode(file_get_contents($this->url().$ip), true);

            return new Fluent($response);
        } catch (\Exception $e) {
            return false;
        }
    }
}

Then, insert your driver class name into the configuration file:

/*
|--------------------------------------------------------------------------
| Driver
|--------------------------------------------------------------------------
|
| The default driver you would like to use for location retrieval.
|
*/

'driver' => App\Locations\MyDriver::class,

ekstro / location