1. Introduction
2. Demo
3. Installation
4. Usage
5. Report
6. License
7. Resources

Introduction ¶

An IP address information display widget for Yii framework 2.0 with ability to display country flag and geo position info. This is based on the PHP API from hostip.info to parse IP address details. The plugin also uses the yii2-popover-x extension by Krajee for displaying details of the IP in a popover. The key features provided are:

• Ability to display the flag for a IP address.
• Ability to display geo position details for the IP address.
• Ability to render IP details inline instead of popover.
• Ability to return a raw json that return details for the IP address.
• Use yii2-popover-x extension features to control popover placements and styles.
• Uses Yii i18N translations to generate locale specific data.

Demo ¶

You can see detailed documentation and examples on usage of the extension.

Installation ¶

The preferred way to install this extension is through composer.

Note: Check the composer.json for this extension's requirements and dependencies. Read this web tip /wiki on setting the minimum-stability settings for your application's composer.json.

Either run

$ php composer.phar require kartik-v/yii2-ipinfo "@dev"

or add

"kartik-v/yii2-ipinfo": "@dev"

to the `require` section of your composer.json file.

Usage ¶

IpInfo ¶

use kartik\ipinfo\IpInfo;

echo IpInfo::widget([
    'ip' => '12.23.155.123',
    /**
     * optionally setup more options
     * refer docs for all options
     */
    // 'showFlag' => true,
    // 'showPosition' => true,
    // 'showPopover' => true,
    // 'showJson' => false,
    // 'showCredits' => true,
    // 'popoverOptions' => [],
    // 'flagOptions' => []
]);

Report ¶

• Report any issues on the project page
• Use the forum page for any discussions on this extension

License ¶

yii2-ipinfo is released under the BSD 3-Clause License. See the bundled LICENSE.md for details.

Resources ¶

• Github Project
• Packagist Package
• Documentation & Demo