README

workbunny/webman-ip-attribution

🐇 Webman plugin for IP attribution query. 🐇

Webman plugin for IP attribution query.

简介

该插件自带ip本地库，存放于/database；最后更新时间：2024-07-05 (空了就时不时更新一下)
- 注：由于db文件比较大，强烈建议外载
  1. 至 https://www.maxmind.com/ 注册账号
  2. 进入下载页面下载对应db文件
webman-ip-attribution 是基于geoip2作为底层，依托 mmdb数据库 查询ip归属地及asn信息
本项目基于geoip2/geoip2，感谢MaxMind 工作组的开源

安装

composer require workbunny/webman-ip-attribution

使用

配置

1. 在Webman中使用app.php

注：配置可选填

return [
    'enable' => true,
    
    'default'  => '--',      // 缺省展示值
    'language' => ['zh-CN'], // 语言

    'db-country' => null,    // 自定义的country库绝对地址
    'db-city'    => null,    // 自定义的city库绝对地址
    'db-asn'     => null,    // 自定义的asn库绝对地址
];

2. 在php-fpm中使用

注：配置可选填

use Workbunny\WebmanIpAttribution\Location;

$location = new Location([
    'default'  => '--',      // 缺省展示值
    'language' => ['zh-CN'], // 语言
    'db-country' => null,    // 自定义的country库绝对地址
    'db-city'    => null,    // 自定义的city库绝对地址
    'db-asn'     => null,    // 自定义的asn库绝对地址
]);

快速获取

use Workbunny\WebmanIpAttribution\Location;
use Workbunny\WebmanIpAttribution\Exceptions\IpAttributionException

try {
     $location = new Location();
     var_dump($location->getLocation('8.8.8.8')); // ipv4
     var_dump($location->getLocation('::0808:0808')); // ipv6
//     [
//         'country' => 'United States',
//         'city' => '--',
//         'asn' => 'GOOGLE',
//         'continent' => 'North America',
//         'timezone' => 'America/Chicago',
//     ]
 }catch (IpAttributionException $exception){
 
 }

使用city库查询

注：City库包含了大洲、国家、城市，但不包含网络运营商等相关信息

use Workbunny\WebmanIpAttribution\Location;
use Workbunny\WebmanIpAttribution\Exceptions\IpAttributionException

try {
   $location = new Location();
    var_dump($location->city('8.8.8.8')); // ipv4
    var_dump($location->city('::0808:0808')); // ipv6
    // 返回 GeoIp2\Model\City 对象
    
 }catch (IpAttributionException $exception){
 
 }

使用country库查询

注：Country库不包含城市及网络运营商等信息，通常使用City库即可，Country存在的意义在于较于City更轻

use Workbunny\WebmanIpAttribution\Location;
use Workbunny\WebmanIpAttribution\Exceptions\IpAttributionException

try {
   $location = new Location();
    var_dump($location->country('8.8.8.8')); // ipv4
    var_dump($location->country('::0808:0808')); // ipv6
    // 返回 GeoIp2\Model\Country 对象
    
 }catch (IpAttributionException $exception){
 
 }

使用asn库查询

注：Asn库仅包含网络运营商等相关信息

use Workbunny\WebmanIpAttribution\Location;
use Workbunny\WebmanIpAttribution\Exceptions\IpAttributionException

try {
   $location = new Location();
    var_dump($location->asn('8.8.8.8')); // ipv4
    var_dump($location->asn('::0808:0808')); // ipv6
    // 返回 GeoIp2\Model\Asn 对象
    
 }catch (IpAttributionException $exception){
 
 }

使用原始Reader操作

注：原始Reader可以直接使用 geoip2/geoip2 提供的方法操作相关的库

use Workbunny\WebmanIpAttribution\Location;

$location = new Location();
var_dump($location->createReader(Location::DB_CITY)); // City库
// 返回连接City库的 GeoIp2\Database\Reader 对象
var_dump($location->createReader(Location::DB_ASN)); // ASN库
// 返回连接ASN库的 GeoIp2\Database\Reader 对象   
var_dump($location->createReader(Location::DB_ASN)); // Country库
// 返回连接Country库的 GeoIp2\Database\Reader 对象

更多用法和示例参照 geoip2/geoip2；

workbunny / webman-ip-attribution

Maintainers

Details