kartik-v/yii2-ipinfo

An IP address information display widget for Yii 2.0 with country flag and geo position info.

dev-master / 1.0.x-dev 2017-09-11 17:15 UTC

README

Latest Stable Version License Total Downloads Monthly Downloads Daily Downloads

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 HTTP API from freegeoip.net 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, and the yii2-icons extension by Krajee for displaying the flag icons.

Features

  • 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 configure fields rendered and also control the layout with templates.
  • Use yii2-popover-x extension features to control popover placements and styles.
  • Use flag icons from yii2-icons to render country wise high resolution flags of any size.
  • Uses Yii i18N translations to generate locale specific data.

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.

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,
    // 'showPopover' => true,
    // 'popoverOptions' => [],
    // 'flagWrapperOptions' => []
    // 'flagOptions' => []
]);

License

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