CravlerMaxMindGeoIpBundle
Installation
Step 1: Download the Bundle
``` bash
composer require cravler/maxmind-geoip-bundle:3.x-dev, (*1)
This command requires you to have Composer installed globally, as explained
in the [installation chapter](https://getcomposer.org/doc/00-intro.md) of the Composer documentation.
### Step 2: Enable the Bundle
This bundle should be automatically enabled by [Flex](https://symfony.com/doc/current/setup/flex.html).
In case you don't use Flex, you'll need to manually enable the bundle by
adding the following line in the `config/bundles.php` file of your project:
``` php
<?php
// config/bundles.php
return [
// ...
Cravler\MaxMindGeoIpBundle\CravlerMaxMindGeoIpBundle::class => ['all' => true],
];
Configuration
The default configuration for the bundle looks like this:, (*2)
``` yaml
cravler_max_mind_geo_ip:
client:
user_id: ~
license_key: ~
options: {}
path: '%kernel.project_dir%/resources/MaxMind'
db:
country: 'GeoIP2-Country.mmdb'
city: 'GeoIP2-City.mmdb'
asn: 'GeoIP2-ASN.mmdb'
connection_type: 'GeoIP2-Connection-Type.mmdb'
anonymous_ip: 'GeoIP2-Anonymous-IP.mmdb'
enterprise: 'GeoIP2-Enterprise.mmdb'
domain: 'GeoIP2-Domain.mmdb'
isp: 'GeoIP2-ISP.mmdb'
source:
country: ~
city: ~
asn: ~
connection_type: ~
anonymous_ip: ~
enterprise: ~
domain: ~
isp: ~
md5_check:
country: ~
city: ~
asn: ~
connection_type: ~
anonymous_ip: ~
enterprise: ~
domain: ~
isp: ~, (*3)
If you need a `GeoLite2` license:
1. [Sign up for a MaxMind account](https://www.maxmind.com/en/geolite2/signup) (no purchase required)
2. Set your password and create a [license key](https://www.maxmind.com/en/accounts/current/license-key)
`Will this key be used for GeoIP Update? > No`
```yaml
# config/packages/cravler_max_mind_geo_ip.yaml
parameters:
max_mind.license_key: '<YOUR_LICENSE_KEY>'
cravler_max_mind_geo_ip:
source:
country: 'https://download.maxmind.com/app/geoip_download?edition_id=GeoLite2-Country&suffix=tar.gz&license_key=%max_mind.license_key%'
city: 'https://download.maxmind.com/app/geoip_download?edition_id=GeoLite2-City&suffix=tar.gz&license_key=%max_mind.license_key%'
asn: 'https://download.maxmind.com/app/geoip_download?edition_id=GeoLite2-ASN&suffix=tar.gz&license_key=%max_mind.license_key%'
md5_check:
country: 'https://download.maxmind.com/app/geoip_download?edition_id=GeoLite2-Country&suffix=tar.gz.md5&license_key=%max_mind.license_key%'
city: 'https://download.maxmind.com/app/geoip_download?edition_id=GeoLite2-City&suffix=tar.gz.md5&license_key=%max_mind.license_key%'
asn: 'https://download.maxmind.com/app/geoip_download?edition_id=GeoLite2-ASN&suffix=tar.gz.md5&license_key=%max_mind.license_key%'
If you have bought a license:, (*4)
``` yaml, (*5)
config/packages/cravler_max_mind_geo_ip.yaml
parameters:
max_mind.user_id: ''
max_mind.license_key: '', (*6)
cravler_max_mind_geo_ip:
client:
user_id: '%max_mind.user_id%'
license_key: '%max_mind.license_key%'
...
source:
country: 'https://download.maxmind.com/app/geoip_download?edition_id=GeoIP2-Country&suffix=tar.gz&license_key=%max_mind.license_key%'
...
md5_check:
country: ~
..., (*7)
> **NB!** Do not forget to change your license data.
## Download and update the MaxMind GeoIp2 database
``` bash
php bin/console cravler:maxmind:geoip-update
You can use the --no-md5-check option if you want to skip MD5 check., (*8)
``` bash
php bin/console cravler:maxmind:geoip-update --no-md5-check, (*9)
## How to use
### Database Reader
``` php
$geoIpService = $container->get('cravler_max_mind_geo_ip.service.geo_ip_service');
// Replace "city" with the appropriate method for your database, e.g., "country".
$record = $geoIpService->getRecord('128.101.101.101', 'city');
print($record->country->isoCode . "\n"); // 'US'
print($record->country->name . "\n"); // 'United States'
print($record->city->name . "\n"); // 'Minneapolis'
Web Service Client
``` php
$geoIpService = $container->get('cravler_max_mind_geo_ip.service.geo_ip_service');, (*10)
$client = $geoIpService->getClient();, (*11)
$record = $client->city('128.101.101.101');, (*12)
## License
This bundle is under the MIT license. See the complete license in the bundle:
LICENSE
```, (*13)
Wallogit.com
