kukla-svitla/yii2-geoip

Yii 2 GeoIP extension. Returns country, city, lat, lng of current or specified IP (uses MaxMind's GeoIP2 databases)

1.0.1 2023-11-04 21:08 UTC

Requires

• php: >=5.4.0
• kukla-svitla/maxmind-geolite2-database: dev-main
• maxmind-db/reader: ~1.0
• yiisoft/yii2: ^2.0.0

Requires (Dev)

• phpunit/phpunit: ~4.4

MIT

• Olexandr Kukla

• geolocation
• maxmind
• geoip
• yii2

README

Provides information about geographical location of user by IP address.

Currently available:

• Country
• City
• Latitude, Longitude
• Country ISO Code

Install

Run

$ php composer.phar require kukla-svitla/yii2-geoip "~1.0"

OR

add to your composer.json

{
    "require": {
        "kukla-svitla/yii2-geoip": "~1.0"
    }
}

and run

$ php composer update

Usage

Like component

<?php

$config = [
    ...
    'components' => [
        'geoip' => ['class' => 'svitla\GeoIP\GeoIP'],
    ]
    ...
];

somewhere in code

$ip = Yii::$app->geoip->ip(); // current user ip

$ip = Yii::$app->geoip->ip("208.113.83.165");

$ip->city; // "San Francisco"
$ip->country; // "United States"
$ip->location->lng; // 37.7898
$ip->location->lat; // -122.3942
$ip->isoCode; // "US"

Like object directly somewhere in your application

$geoip = new \svitla\GeoIP\GeoIP();
$ip = $geoip->ip("208.113.83.165");

$ip->city; // "San Francisco"
$ip->country; // "United States"
$ip->location->lng; // 37.7898
$ip->location->lat; // -122.3942
$ip->isoCode;  // "US"

Provide a custom database (for example, if you own a licence)

<?php

$config = [
    ...
    'components' => [
        'geoip' => [
            'class' => 'svitla\GeoIP\GeoIP',
            'dbPath' => Yii::getAlias('@example/maxmind/database/city.mmdb')
        ],
    ]
    ...
];

This product includes GeoLite2 data created by MaxMind, available from http://www.maxmind.com