Yii2 GeoIP - City DB version

Yii2 Component to allow for easy usage of the MaxMind Free dbs., _(*1)

Based on package phiphi1992/Yii2-GeoIP by Phi Hoang Xuan., _(*2)

Installation

The preferred way to install this extension is through composer., _(*3)

Either run, _(*4)

php composer.phar require dpodium/yii2-geoip-city-db "~0.2"

or add, _(*5)

"dpodium/yii2-geoip-city-db "~0.2"

to the require section of your composer.json file., _(*6)

Component Setup

Once the extension is installed, simply modify your application configuration as follows:, _(*7)

return [
    'components' => [
    ...
        'geoip' => [
                   'class' => 'dpodium\yii2\geoip\components\CGeoIP',
               ],
        ...
    ],
    ...
];

If querying only partial Country data is required, yii2-geoip can be used instead and is lighter in terms of repo size, see dpodium/yii2-geoip., _(*8)

For more information on the data availability, see below., _(*9)

Usage

All methods accept an IP address as an argument. If no argument is supplied Yii::$app->getRequest()->getUserIP() is used., _(*10)

//Along with free DB
$location = Yii::$app->geoip->lookupLocation();
$countryCode = Yii::$app->geoip->lookupCountryCode();
$countryName = Yii::$app->geoip->lookupCountryName();

Location attributes:, _(*11)

$location->countryCode //Available in both Country and City DB
$location->countryName //Available in both Country and City DB
$location->continentCode //Available in both Country and City DB
$location->continentName //Available in both Country and City DB
$location->city //Available in only City DB
$location->postalCode //Available in only City DB
$location->latitude //Available in only City DB
$location->longitude //Available in only City DB
$location->timeZone //Available in only City DB