omnilight/yii2-sypexgeo

Yii2 extension for Sypex Geo API (http://sypexgeo.net)

Yii2 extension for Sypex Geo API (http://sypexgeo.net)

This extension adds support for Sypex Geo to the Yii2 framework, _(*1)

Note: This is not the fork of the JiSoft/yii2-sypexgeo!, _(*2)

Installation

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

Either run, _(*4)

php composer.phar require --prefer-dist omnilight/yii2-sypexgeo "*"

or add, _(*5)

"omnilight/yii2-sypexgeo": "*"

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

What it is all about?

Sypex Geo - product for location by IP address. Obtaining the IP address, Sypex Geo outputs information about the location of the visitor - country, region, city, geographical coordinates and other in Russian and in English. Sypex Geo use local compact binary database file and works very quickly. For more information visit: http://sypexgeo.net/, _(*7)

This is extension for Yii2 framework that makes it easy to deal with Sypex Geo., _(*8)

Usage

Unfortunately original version of Sypex Geo does not support Composer installation, so we have to include it into this extension., _(*9)

First of all, you have to download desired database from the http://sypexgeo.net/ website and place it somewhere on your server., _(*10)

There are two classes in this extension., _(*11)

Sypexgeo - this is the component that can be used to retrive Geo information based on IP address. This component incapsulates calls to the SxGeo methods., _(*12)

You can use it as an application component:, _(*13)

// config.php
[
    'components' => [
        'sypexGeo' => [
            'class' => 'omnilight\sypexgeo\SypexGeo',
            'database' => '@app/data/SxGeoCity.dat',
        ]
    ]
]

// somewhere in your code
$city = Yii::$app->sypexGeo->getCity($ip);

Also you can create instance by yourself:, _(*14)

$sypexGeo = new omnilight\sypexgeo\Sypexgeo([
    'database' => '@app/data/SxGeoCity.dat',
]);
$city = $sypexGeo->getCity($ip);

GeoBehavior - behavior that can be attached to the yii\web\Request or it's children and this class adds methods to simplify getting Geo information for current request., _(*15)

Example:, _(*16)

// config.php
[
    'components' => [
        'request' => [
            'as sypexGeo' => [
                'class' => 'omnilight\sypexgeo\GeoBehavior',
                // It is not required to define property sypexGeo if you have sypexGeo component defined
                // in your application
                'sypexGeo' => [
                    'database' => '@app/data/SxGeoCity.dat',
                ]
            ]
        ]
    ],
]

// In your code
$city = Yii::$app->request->getCity();