dpodium / yii2-geoip-city-db
Yii2 Component to allow for easy usage of the MaxMind Free dbs.
Installs: 12 756
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 5
Forks: 0
Open Issues: 0
Language:Shell
Type:yii2-extension
Requires
- dpodium/yii2-geoip: ~2.0
This package is auto-updated.
Last update: 2024-10-27 04:59:12 UTC
README
Yii2 Component to allow for easy usage of the MaxMind Free dbs.
Based on package phiphi1992/Yii2-GeoIP by Phi Hoang Xuan.
Installation
The preferred way to install this extension is through composer.
Either run
php composer.phar require dpodium/yii2-geoip-city-db "~0.2"
or add
"dpodium/yii2-geoip-city-db "~0.2"
to the require section of your composer.json
file.
Component Setup
Once the extension is installed, simply modify your application configuration as follows:
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.
For more information on the data availability, see below.
Usage
All methods accept an IP address as an argument. If no argument is supplied Yii::$app->getRequest()->getUserIP() is used.
//Along with free DB
$location = Yii::$app->geoip->lookupLocation();
$countryCode = Yii::$app->geoip->lookupCountryCode();
$countryName = Yii::$app->geoip->lookupCountryName();
Location attributes:
$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