README

这是法国政府提供的API Geo的PHP包装器。

安装

使用Composer，在您的composer.json文件中添加以下行

"phelium/geoapifr": "dev-master"

然后运行composer update。

或者，在您的终端中直接执行以下命令

composer require phelium/geoapifr

使用方法

require 'vendor/autoload.php';

use Phelium\Component\GeoApiFr;

市镇

要获取一个市镇的详细信息，请使用communes()方法。

返回的字段包括

允许搜索的字段包括

以下是一个搜索名为"Versailles"的市镇的示例

$GeoApiFr = new \Phelium\Component\GeoApiFr;
$datas = $GeoApiFr
    ->communes()
    ->fields(array('code', 'codeDepartement', 'codeRegion', 'nom'))
    ->search('nom', 'Versailles');

返回结果

Array
(
    [status_code] => 200
    [status_msg] => OK
    [url] => https://geo.api.gouv.fr/communes?nom=Versailles&fields=code,codeDepartement,codeRegion,nom
    [datas] => Array
        (
            [0] => Array
                (
                    [code] => 78646
                    [codeDepartement] => 78
                    [codeRegion] => 11
                    [nom] => Versailles
                    [_score] => 1
                )

        )
)

省

要获取一个省的详细信息，请使用departements()方法。

返回的字段包括

允许搜索的字段包括

以下是一个搜索代码为"2A"的省的示例

$GeoApiFr = new \Phelium\Component\GeoApiFr;
$datas = $GeoApiFr
    ->departements()
    ->fields(array('code', 'codeRegion', 'nom'))
    ->search('code', '2A');

返回结果

Array
(
    [status_code] => 200
    [status_msg] => OK
    [url] => https://geo.api.gouv.fr/departements?code=2A&fields=code,codeRegion,nom
    [datas] => Array
        (
            [0] => Array
                (
                    [code] => 2A
                    [codeRegion] => 94
                    [nom] => Corse-du-Sud
                )

        )
)

地区

要获取一个地区的详细信息，请使用regions()方法。

返回的字段包括

允许搜索的字段包括

以下是一个搜索代码为"94"的地区示例

$GeoApiFr = new \Phelium\Component\GeoApiFr;
$datas = $GeoApiFr
    ->regions()
    ->fields(array('code', 'nom'))
    ->search('code', '94');

返回结果

Array
(
    [status_code] => 200
    [status_msg] => OK
    [url] => https://geo.api.gouv.fr/regions?code=94&fields=code,nom
    [datas] => Array
        (
            [0] => Array
                (
                    [code] => 94
                    [nom] => Corse
                )

        )
)