Location
Location stats
- Downloads
- 3M
- Stars
- 912
- Open Issues
- 11
- Forks
- 167
Retrieve a user's location by their IP Address
Laravel Location Package Summary
Laravel Location is a versatile package for retrieving a user's geographical location based on their IP address. It supports multiple services and is easy to integrate with Laravel projects.
Key Features
- Multiple Drivers: Supports various services like IpApi, IpData, IpInfo, and more, including the ability to set up a local MaxMind database.
- Fallback Drivers: Automatically uses fallback drivers if the primary fails, ensuring reliability.
- Custom Driver Support: Developers can create and integrate custom location drivers.
- IP Address Specific Location: Retrieve location data for any specified IP address.
- Configurable and Extendable: Includes publishable config files for easy customization.
Installation
Install via composer:
composer require stevebauman/location
Publish the configuration file:
php artisan vendor:publish --provider="Stevebauman\Location\LocationServiceProvider"
Usage
Retrieve the location of the client's IP:
use Stevebauman\Location\Facades\Location; if ($position = Location::get()) { echo $position->countryName;} else { // Handle failure}
Retrieve the location for a specific IP:
$position = Location::get('192.168.1.1');
Setting Up Drivers
MaxMind Local Setup
- Create an account and obtain a license key from MaxMind.
- Add the
MAXMIND_LICENSE_KEYto your.envfile. - Run
php artisan location:updateto download and set up the local database.
Custom Drivers
Create by extending the Driver or HttpDriver classes, and configure in location.php.
Upgrading from v6
Version 7 introduces strict types, updated dependencies, and a new driver structure. Custom drivers need to be updated to match the new base classes.
Versioning
Follows Semantic Versioning. Major updates may break backward compatibility, while minor and patches focus on new features and bug fixes respectively.
This package is ideal for developers needing to implement IP-based geolocation in their Laravel applications with flexibility and ease.