https://github.com/snapshotpl/zfsnapgeoip
Maxmind Geoip module for Zend Framework 2
https://github.com/snapshotpl/zfsnapgeoip
geoip maxmind-geoip module zend-framework
Last synced: about 1 month ago
JSON representation
Maxmind Geoip module for Zend Framework 2
- Host: GitHub
- URL: https://github.com/snapshotpl/zfsnapgeoip
- Owner: snapshotpl
- Created: 2013-07-12T21:24:45.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2019-07-07T09:50:44.000Z (almost 6 years ago)
- Last Synced: 2025-03-17T19:39:29.153Z (about 2 months ago)
- Topics: geoip, maxmind-geoip, module, zend-framework
- Language: PHP
- Size: 78.1 KB
- Stars: 15
- Watchers: 4
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
ZfSnapGeoip [](https://travis-ci.org/snapshotpl/ZfSnapGeoip) [](https://scrutinizer-ci.com/g/snapshotpl/ZfSnapGeoip/?branch=master)
===========
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:**
```php
$record = $this->getServiceLocator()->get('geoip')->getRecord();
echo $record->getCity();
```
```php
$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
geoip() ?>
```
Returns country name for given IP:
```php
geoip('184.106.35.179')->getCountryName() ?>
```
You can also implements `\ZfSnapGeoip\IpAwareInterface` interface and then use instance in service/helper:
```php
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](https://getcomposer.org/)
```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):
```json
{
"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,