https://github.com/dotkernel/dot-geoip
DotKernel component based on Maxmind's geoip2/geoip2 package, using their free GeoLite2 databases to provide geographical details about an IP address.
https://github.com/dotkernel/dot-geoip
Last synced: about 2 months ago
JSON representation
DotKernel component based on Maxmind's geoip2/geoip2 package, using their free GeoLite2 databases to provide geographical details about an IP address.
- Host: GitHub
- URL: https://github.com/dotkernel/dot-geoip
- Owner: dotkernel
- License: mit
- Created: 2019-11-18T12:35:09.000Z (over 5 years ago)
- Default Branch: 3.0
- Last Pushed: 2025-02-24T11:03:14.000Z (4 months ago)
- Last Synced: 2025-04-26T18:16:50.688Z (about 2 months ago)
- Language: PHP
- Homepage: https://docs.dotkernel.org/dot-geoip/
- Size: 4.15 MB
- Stars: 5
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# dot-geoip
Dotkernel component to provide geographical details about an IP address
> dot-geoip is a wrapper on top of [maxmind/GeoIP2-php](https://github.com/maxmind/GeoIP2-php)
## Documentation
Documentation is available at: https://docs.dotkernel.org/dot-geoip/.
## Badges
[](https://github.com/dotkernel/dot-geoip/issues)
[](https://github.com/dotkernel/dot-geoip/network)
[](https://github.com/dotkernel/dot-geoip/stargazers)
[](https://github.com/dotkernel/dot-geoip/blob/3.0/LICENSE)
[](https://github.com/dotkernel/dot-geoip/actions/workflows/continuous-integration.yml)
[](https://codecov.io/gh/dotkernel/dot-geoip)
[](https://github.com/dotkernel/dot-geoip/actions/workflows/static-analysis.yml)
## Install
You can install this library by running the following command:
```shell
composer require dotkernel/dot-geoip
```
If your application didn't already use it, the above command also installed [dotkernel/dot-cli](https://github.com/dotkernel/dot-cli).
In this case, see it's [README](https://github.com/dotkernel/dot-cli/blob/3.0/README.md) file on how to use it.
Copy config file `vendor/dotkernel/dot-geoip/config/autoload/geoip.global.php` into your application's `config/autoload` directory.
Register the library's ConfigProvider by adding the following line to your application's `config/config.php` file:
```php
Dot\GeoIP\ConfigProvider::class,
```
Register the library's synchronizer command by adding the following line to your application's `config/autoload/cli.global.php` file under the `commands` array key:
```php
Dot\GeoIP\Command\GeoIpCommand::getDefaultName() => Dot\GeoIP\Command\GeoIpCommand::class,
```
## Manage GeoLite2 database
You can download/update a specific GeoLite2 database, by running the following command:
```shell
php ./bin/cli.php geoip:synchronize -d {DATABASE}
```
Where _{DATABASE}_ takes one of the following values: `asn`, `city`, `country`.
You can download/update all GeoLite2 databases at once, by running the following command:
```shell
php ./bin/cli.php geoip:synchronize
```
The output should be similar to the below, displaying per row: `database identifier`: `previous build datetime` -> `current build datetime`.
```text
asn: n/a -> 2021-07-01 02:09:34
city: n/a -> 2021-07-01 02:09:20
country: n/a -> 2021-07-01 02:05:12
```
Get help for this command by running `php ./bin/cli.php help geoip:synchronize`.
> If you set up the synchronizer command as a cronjob, you can add the `-q|--quiet` option, and it will output data only if an error has occurred.
## Usage
Below is an example implementation of using DotGeoip to retrieve information about an IP address.
```php
locationService = $locationService;
}
/**
* @param string $ipAddress
* @return object
*/
public function myMethod(string $ipAddress): object
{
try {
// You can use any of the below methods:
// Get CountryData which includes isEuMember, isoCode and name
return $this->locationService->getCountry($ipAddress);
// Get ContinentData which includes code and name
return $this->locationService->getContinent($ipAddress);
// Get OrganizationData which includes asn and name
return $this->locationService->getOrganization($ipAddress);
// Get LocationData which includes all of the above + estimated coordinates + timezone
return $this->locationService->getLocation($ipAddress);
} catch (Throwable $exception) {
// handle errors
}
}
}
```