區(qū)域工具庫(kù)

v1.0.0
版本
2025-07-07
版本更新時(shí)間
0
安裝
2
star
區(qū)域工具庫(kù)
這是一個(gè)用于處理區(qū)域數(shù)據(jù)的PHP工具庫(kù),提供便捷的區(qū)域信息查詢和操作功能。
安裝
使用 Composer 安裝:
composer require wxiaohua/area
功能特性
- 支持通過(guò)ID獲取區(qū)域信息
- 路徑解析與構(gòu)建功能
- 地址格式化輸出
- 按類型篩選區(qū)域數(shù)據(jù)
- 獲取指定類型的上級(jí)區(qū)域
目錄結(jié)構(gòu)
src/
├── AreaFacade.php # 門面類,提供靜態(tài)調(diào)用接口
├── AreaUtils.php # 核心工具類,實(shí)現(xiàn)主要功能
├── config/ # 配置文件目錄
└── database/ # 數(shù)據(jù)文件目錄(包含area.csv區(qū)域數(shù)據(jù)文件)
使用示例
初始化
// 使用默認(rèn)配置初始化
AreaFacade::init();
// 自定義配置初始化
AreaFacade::init([
'csv_file_path' => '/path/to/custom/area.csv'
]);
基礎(chǔ)用法
// 獲取區(qū)域信息
$area = AreaFacade::get(110100); // 獲取北京市信息
// 解析區(qū)域路徑
$result = AreaFacade::parse('全球/中國(guó)/北京市/朝陽(yáng)區(qū)');
// 格式化地址輸出
$formatted = AreaFacade::format(110105, ' '); // 輸出:北京市 朝陽(yáng)區(qū)
// 按類型獲取區(qū)域
$provinces = AreaFacade::byType(AreaUtils::PROVINCE, function($area) {
return $area['name'];
});
// 獲取指定類型的上級(jí)區(qū)域
$provinceId = AreaFacade::parentOfType(110105, AreaUtils::PROVINCE);
單元測(cè)試
項(xiàng)目包含完整的單元測(cè)試,測(cè)試覆蓋率高,確保功能穩(wěn)定性。
許可證
本項(xiàng)目采用 MIT 許可證。詳見(jiàn) LICENSE 文件。