migda/gugik-php-sdk

PHP SDK for http://capap.gugik.gov.pl/api/fts/ API

dev-main 2021-09-19 18:34 UTC

This package is auto-updated.

Last update: 2024-09-20 00:56:28 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

请在使用此包之前阅读CAPAP GUGiK API的使用条款: http://capap.gugik.gov.pl/api/fts/#_informacja_o_licencji

PHP SDK for http://capap.gugik.gov.pl/api/fts/ API - 波兰行政区划、地址、地块等的地理编码和反向地理编码。

这是CAPAP GUGiK API的非官方PHP SDK。

安装

您可以通过composer安装此包

composer require migda/gugik-php-sdk

用法

// Geocode commune

$gugik = new Gugik();

$reqs = new GcSingleJpaCollection([
    new GcSingleJpa([
        "gm_nazwa" => "dębno",
        "pow_nazwa" => "brzeski",
        "woj_nazwa" => "małopolskie",
    ]),
]);

$req = new GcReqJpa([
    'reqs' => $reqs,
]);

$results = $gugik->gcGmi($req);
$currentResult = $results->current();
// Reverse geocode address point

$gugik = new Gugik();

$req = new RgcReqAdr([
    'd' => 500.00,
    'x' => 16.925,
    'y' => 51.089,
]);

$result = $gugik->rgcAdr($req);
// Reverse geocode plot

$gugik = new Gugik();

$req = new RgcReqDze([
    'd' => 500.00,
    'x' => 16.925,
    'y' => 51.089,
]);

$result = $gugik->rgcDze($req);

可用方法

地理编码

/**
 * Geokodowanie działek - lpis
 * Geocode plots (lpis) using post
 *
 * http://capap.gugik.gov.pl/api/fts/#_geocodedzelpisusingpost
 */
public function gcDzeLpis(GcReqDze $req): GcResultCollection

/**
 * Geokodowanie gmin
 * Geocode communes using post
 *
 * http://capap.gugik.gov.pl/api/fts/#_geocodegmiusingpost
 */
public function gcGmi(GcReqJpa $req): GcResultCollection

反向地理编码

/**
 * Odwrotne geokodowanie - punkty adresowe
 * Reverse geocode address points using get
 *
 * http://capap.gugik.gov.pl/api/fts/#_d8df035f1b22f89d3c826789834b2d65
 */
public function rgcAdr(RgcReqAdr $req): GcResult


/**
 * Odwrotne geokodowanie - działki
 * Reverse geocode plots using get
 *
 * http://capap.gugik.gov.pl/api/fts/#_dzeusingget
 */
public function rgcDze(RgcReqDze $req): GcResult

测试

composer test

变更日志

请参阅CHANGELOG获取有关最近更改的更多信息。

待办事项

  1. 处理更多端点: http://capap.gugik.gov.pl/api/fts/
  2. 更复杂的DTO响应(目前只有非常基础的GcResult类)
  3. 更多测试
  4. 改进异常

贡献

请参阅CONTRIBUTING获取详细信息。

安全漏洞

请查阅我们的安全策略以了解如何报告安全漏洞。

致谢

许可协议

MIT许可协议(MIT)。有关更多信息,请参阅许可文件