README

Determine the geographical location and currency of website visitors based on their IP addresses.

About this fork

We have forked torann/geoip as it’s almost not actively maintained anymore. This fork works with modern PHP versions only (8.0+), maintained and includes additional features:

Support modern Laravel and PHP versions
Better types (native and PHPDoc)
Safer file and network functionality
Ability to prefix cache keys (cache_prefix config option)
Updated currencies
More predictable exceptions

But don’t worry, we are following SemVer 2.0. The package migration is straightforward.

Installation

From the command line run:

composer require interaction-design-foundation/laravel-geoip

Publish the configurations

Run this on the command line from the root of your project:

php artisan vendor:publish --provider="InteractionDesignFoundation\GeoIP\GeoIPServiceProvider" --tag=config

Configuration

Quick breakdown of the two main options in the configuration file. To find out more simple open the config/geoip.php file.

Service Configuration

To simplify and keep things clean, all third party composer packages, which are needed for a service, are installed separately.

For further configuration options, checkout the services page.

Caching Configuration

GeoIP uses Laravel’s default caching to store queried IP locations. This is done to reduce the number of calls made to the selected service, as some of them are rate limited.

Options:

all all locations are cached
some cache only the requesting user
none caching is completely disabled

Usage

There are few options to use the package:

geoip() helper function
InteractionDesignFoundation\GeoIP\Facades\GeoIP facade

geoip()->getLocation('27.974.399.65'); // Get the location from the provided IP.
geoip()->getClientIP(); // Will return the user IP address.

Example of a Location object:

\InteractionDesignFoundation\GeoIP\Location {[
    'ip'           => '1.1.1.1',
    'iso_code'     => 'US',
    'country'      => 'United States',
    'city'         => 'New Haven',
    'state'        => 'CT',
    'state_name'   => 'Connecticut',
    'postal_code'  => '06510',
    'lat'          => 41.28,
    'lon'          => -72.88,
    'timezone'     => 'America/New_York',
    'continent'    => 'NA',
    'currency'     => 'USD',
    'default'      => false,
]}

Location class implements \ArrayAccess interface, means you can access properties of the Location object using both object and array access:

$location = geoip()->getLocation();

$city = $location->city;
// The same as:
$city = $location['city'];

Artisan

Some services require downloading and use a local database to detect Location by IP address. There is a console command to download/update database:

php artisan geoip:update

Some cache drivers offer the ability to clear cached locations:

php artisan geoip:clear

Changelog

Please see Releases for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Contributions

Many people have contributed to the project since its inception.

Thanks to:

Daniel Stainback (creator of the original package)
Dwight Watson
nikkiii
jeffhennis
max-kovpak
dotpack
Jess Archer

interaction-design-foundation / laravel-geoip

Maintainers

Details