Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yiicod/yii2-geo

geo ip-location ip-locator yii2 yii2-extension

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/yiicod/yii2-geo
Owner: yiicod
Created: 2017-09-13T07:07:13.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2018-07-27T11:50:21.000Z (over 6 years ago)
Last Synced: 2024-10-01T14:25:31.890Z (3 months ago)
Topics: geo, ip-location, ip-locator, yii2, yii2-extension
Language: PHP
Size: 13.7 KB
Stars: 7
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        Yii Geo position getter extension

=================================

[![Latest Stable Version](https://poser.pugx.org/yiicod/yii2-geo/v/stable)](https://packagist.org/packages/yiicod/yii2-geo) [![Total Downloads](https://poser.pugx.org/yiicod/yii2-geo/downloads)](https://packagist.org/packages/yiicod/yii2-geo) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/yiicod/yii2-geo/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/yiicod/yii2-geo/?branch=master)[![Code Climate](https://codeclimate.com/github/yiicod/yii2-geo/badges/gpa.svg)](https://codeclimate.com/github/yiicod/yii2-geo)

This extension will help you to find user country and country code.

It use two online and one offline system for find information about user. You no need worry

what system will use because all of this will do one component GeoFinder

#### Installation

The preferred way to install this extension is through [composer](http://getcomposer.org/download/).

Either run

```

php composer.phar require --prefer-dist yiicod/yii2-geo "*"

```

or add

```json

"yiicod/yii2-geo": "*"

```

to the require section of your composer.json.

#### Config for frontend

```php

'container' => [

    'singletons' => [

        \yiicod\geo\storages\StorageInterface::class => [

            'class' => \yiicod\geo\storages\CacheStorage::class,

        ],

    ],

],

'components' => [

    'geoFinder' => [

        'class' => yiicod\geo\components\GeoFinder::class,

        'gettersList' => [

            [

                'class' => \yiicod\geo\adapters\geoIp2\GeoIp2CityAdapter::class,

                'databaseConfig' => [

                    'class' => \yiicod\geo\adapters\geoIp2\GeoIp2Database::class,

                    'databaseAlias' => '@frontend/runtime',

                ],

            ],

            [

                'class' => \yiicod\geo\adapters\ipstack\IpstackAdapter::class,

                'apiKey' => 'API-key'

            ],

            [

                'class' => \yiicod\geo\adapters\geoPlugin\GeoPluginAdapter::class,

            ],

        ],

    ],

],

```

#### Usage

```php

\yiicod\geo\GeoGetter::getCountryName($ip)

\yiicod\geo\GeoGetter::getCountryCode($ip)

\yiicod\geo\GeoGetter::getRegionName($ip),

\yiicod\geo\GeoGetter::getRegionCode($ip),

\yiicod\geo\GeoGetter::getCity($ip),

\yiicod\geo\GeoGetter::getLatitude($ip),

\yiicod\geo\GeoGetter::getLongitude($ip),

````