README

一个用PHP编写的库，用于获取越南行政区划信息（省、市、区、县、乡、坊、镇...）

安装

使用 composer 进行安装

composer require nguyenary/vietnam-address-api

用法

1. 更新越南行政区划数据（如果有变更）

如果将来越南行政区划数据（区、县、乡、坊等）有变更，您可以主动通过以下方式更新数据。

数据是从以下地址的 excel 文件中提取的：https://danhmuchanhchinh.gso.gov.vn/

如何下载 excel 文件

以下示例是下载河内市行政区划 excel 文件的方法

如何通过 script 下载所有地名 excel 文件

请复制文件 download-script.js 中的代码，访问上述地址。按 Ctrl + Shift + I 打开 console，粘贴代码并按 enter，结果将如图所示。

excel 文件存储在 excel_files 文件夹中

要更新新的行政区划数据，请将已下载的 excel 文件放入此文件夹，并执行命令

cd vendor/nguyenary/vietnam-address-api
php export.php

结果如下

这样，您已成功更新行政区划数据！

或者，您可以在项目内创建 issues 来报告遇到的数据问题，或者主动创建 pull requests 以为此项目贡献新的数据更新。

2. 在项目中使用

require 'vendor/autoload.php';

use NguyenAry\VietnamAddressAPI\Address;

请参考 example.php 文件中的具体示例

`Address::getProvinces()`

获取越南所有省/市

选项
- province_ids (数组) : 包含要获取的省_id的数组

`Address::getProvince()`

根据 province_id 获取一个省/市的信息

必需
- province_id (字符串) : 要获取信息省/市的 province_id

`Address::getDistrictsByProvinceId()`

根据 province_id 获取一个省/市的区/县列表

必需
- province_id (字符串) : 要获取区/县列表的省/市的 province_id

`Address::getDistrict()`

根据 district_id 获取区/县的信息

必需
- district_id (字符串) : 需要获取信息的区/县的 district_id

`Address::getWardsByDistrictId()`

根据 district_id 获取一个区/县的乡/坊/镇列表

必需
- district_id (字符串) : 要获取乡/坊/镇列表的区/县的 district_id

`Address::getWard()`

根据 distric_id 和 ward_id 获取乡/坊/镇的信息

必需
- district_id (字符串) : 包含乡/坊/镇所在的区/县的 district_id
- ward_id (字符串) : 要获取信息的乡/坊/镇的 ward_id

`Address::setSchema()`

重新格式化将返回的字段。在调用上述 get 方法之前调用此方法（默认返回所有字段）

选项
- schema (数组) : 包含需要获取的字段的数组（例如：name, type, code,...等）

nguyenary / vietnam-address-api

维护者

详细信息