README.md

ZfSnapGeoip

Maxmind Geoip module for Zend Framework 2

Created by Witold Wasiczko

Usage

Default ZfSnapGeoip returns Record object created by current user's IP address.

In controller:

$record = $this->getServiceLocator()->get('geoip')->getRecord();
echo $record->getCity();

$record = $this->getServiceLocator()->get('geoip')->getRecord('216.239.51.99');
echo $record->getLongitude();
echo $record->getLatitude();

By view helper:

Returns city name for current IP:

<?php echo $this->geoip() ?>

Returns country name for given IP:

<?php echo $this->geoip('184.106.35.179')->getCountryName() ?>

You can also implements \ZfSnapGeoip\IpAwareInterface interface and then use instance in service/helper:

<?php echo $this->geoip($user)->getTimezone() ?>

Avaliable getter methods via \ZfSnapGeoip\Entity\Record:

getAreaCode()
getCity()
getContinentCode()
getCountryCode()
getCountryCode3()
getCountryName()
getDmaCode()
getLatitude()
getLongitude()
getMetroCode()
getPostalCode()
getRegion()
getRegionName()
getTimezone()

Events

Module supports \Zend\EventManager.

Class	Event name	Description	Params
ZfSnapGeoip\Controller\ConsoleController	downloadAction.exists	If no-clobber is enabled and file exists	path (to dat file)
ZfSnapGeoip\Controller\ConsoleController	downloadAction.pre	Before unzip file	path (to dat file), response (gziped response object)
ZfSnapGeoip\Controller\ConsoleController	downloadAction.post	After unzip file	path (to dat file)
ZfSnapGeoip\Service\Geoip	getIp	After read IP	ip (ip address)
ZfSnapGeoip\Service\Geoip	getRecord	After created record	record (instance of ZfSnapGeoip\Entity\RecordInterface)
ZfSnapGeoip\Service\Geoip	getRegions	After first loading regions names	regions

How to install?

Via composer.json

{
    "require": {
        "snapshotpl/zf-snap-geoip": "2.*"
    }
}

and add ZfSnapGeoip module name to application.config.php

To download data file from http://dev.maxmind.com/geoip/legacy/geolite/ use Zend\Console (you can add this to crontab):

php index/public.php geoip download

Or use autoupdate database during install/update in composer (just add this lines to composer.json and run composer):

{
    "scripts": {
        "post-install-cmd": [
            "ZfSnapGeoip\\Composer\\ScriptHandler::downloadData"
        ],
        "post-update-cmd": [
            "ZfSnapGeoip\\Composer\\ScriptHandler::downloadData"
        ]
    }
}

Console usage

You can download GeoIP database from application console:

php public/index.php geoip download

There are optional parameters:

• --no-clobber Don't overwrite an existing db file,
• -q Turn off output,