Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adrianorsouza/laravel-geolocation
Laravel package to get the details about Region, City and Country for a given IP Address.
https://github.com/adrianorsouza/laravel-geolocation
geoip geoip2 geolocation ip ipinfo iplookup iplookup-php laravel
Last synced: 6 days ago
JSON representation
Laravel package to get the details about Region, City and Country for a given IP Address.
- Host: GitHub
- URL: https://github.com/adrianorsouza/laravel-geolocation
- Owner: adrianorsouza
- License: bsd-3-clause
- Created: 2019-08-13T22:50:25.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-02T08:15:41.000Z (11 months ago)
- Last Synced: 2025-01-02T22:07:56.911Z (13 days ago)
- Topics: geoip, geoip2, geolocation, ip, ipinfo, iplookup, iplookup-php, laravel
- Language: PHP
- Size: 35.2 KB
- Stars: 59
- Watchers: 2
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Laravel GeoLocation Package
===========================
Laravel package to get the details about Region, City and Country for a given IP Address.
This package is a wrapper for [IpInfo](https://ipinfo.io) Provider, however we have plan to implement a driver for
MaxMind GeoIP2 databases.
### Install
composer require adrianorosa/laravel-geolocation
> This package supports the latest version of Laravel, for now 5.8+ was tested, but older versions should work fine.
As of Laravel 5.5 there is no need to add the ServiceProvider within the `AppServiceProvider` array.
Laravel loads this provider using Package Discovery.
### Usage
There is no need to additional setup to start using, once you install it via composer you can call the Facade:
```php
getIp();
// 8.8.8.8
echo $details->getCity();
// Mountain View
echo $details->getRegion();
// California
echo $details->getCountry();
// United States
echo $details->getLatitude();
// 37.386
echo $details->getLongitude();
// -122.0838
var_dump($details->toArray());
// Array
// (
// [city] => Mountain View
// [region] => California
// [country] => United States
// [countryCode] => US
// [latitude] => 37.386
// [longitude] => -122.0838
//)
```
### Console Command
To display details about an Ip or Your current network Ip Address you may use the artisan command:
```bash
php artisan geolocation:lookup --ip 8.8.8.8
+---------+---------------+------------+----------------+-------------+----------+-----------+
| ip | city | region | country | countryCode | latitude | longitude |
+---------+---------------+------------+----------------+-------------+----------+-----------+
| 8.8.8.8 | Mountain View | California | Estados Unidos | US | 37.386 | -122.0838 |
+---------+---------------+------------+----------------+-------------+----------+-----------+
```
## Override Configuration and translations
This package comes with a little configuration for IpInfo and translations for Country Names.
You can stick with default values, which works fine, or publish using the following commands:
Publish all config and translations
php artisan vendor:publish
Publish config
php artisan vendor:publish --tag=geolocation-config
Publish translations
php artisan vendor:publish --tag=geolocation-translations
## Author
**Adriano Rosa** (https://adrianorosa.com)
## Licence
Copyright © 2021, Adriano Rosa
All rights reserved.
For the full copyright and license information, please view the LICENSE
file that was distributed within the source root of this project.