{"id":20719733,"url":"https://github.com/slince/china","last_synced_at":"2025-07-24T10:38:29.028Z","repository":{"id":57053335,"uuid":"110079254","full_name":"slince/China","owner":"slince","description":":cn: 一个轻巧的中国的地区、民族以及节假日信息的查询PHP库","archived":false,"fork":false,"pushed_at":"2022-03-18T10:35:36.000Z","size":1014,"stargazers_count":55,"open_issues_count":1,"forks_count":17,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-06-22T09:38:38.742Z","etag":null,"topics":["address","china","china-address","china-region","holidays","nationality","region","regions"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/slince.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-11-09T06:58:28.000Z","updated_at":"2024-08-22T02:23:46.000Z","dependencies_parsed_at":"2022-08-24T05:31:49.683Z","dependency_job_id":null,"html_url":"https://github.com/slince/China","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/slince/China","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slince%2FChina","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slince%2FChina/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slince%2FChina/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slince%2FChina/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/slince","download_url":"https://codeload.github.com/slince/China/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slince%2FChina/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266828934,"owners_count":23991221,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-24T02:00:09.469Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["address","china","china-address","china-region","holidays","nationality","region","regions"],"created_at":"2024-11-17T03:18:12.261Z","updated_at":"2025-07-24T10:38:28.979Z","avatar_url":"https://github.com/slince.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n   \u003cimg src=\"https://raw.githubusercontent.com/slince/china/master/etc/china.png\" alt=\"中国\"\u003e\n\u003c/p\u003e\n\n我国的资料库查询库；本库主要包含民族、节日、地址库信息的查询；部分数据来源采集自百科以及国家统计局；欢迎收藏欢迎贡献代码；\n\n[![Build Status](https://img.shields.io/github/workflow/status/slince/China/test?style=flat-square)](https://github.com/slince/China/actions)\n[![Coverage Status](https://img.shields.io/codecov/c/github/slince/China/master?style=flat-square)](https://codecov.io/github/slince/China)\n[![Latest Stable Version](https://img.shields.io/packagist/v/slince/china.svg?style=flat-square\u0026label=stable)](https://packagist.org/packages/slince/china)\n[![Scrutinizer](https://img.shields.io/scrutinizer/g/slince/China.svg?style=flat-square)](https://scrutinizer-ci.com/g/slince/China/?branch=master)\n\n\n## Installation\n\n执行下面命令安装\n\n```bash\n\u003e composer require slince/china\n```\n\n## Document\n\n你可以在这里发现[文档](./doc);\n\n## Basic Usage\n\n### 节日查询\n\n```php\n\n$china = new China();\n\n$holidayService = $chna-\u003egetHoliday();\n\nprint_r($holidayService-\u003efindAll());\n\n```\n按名称查找节日\n\n```php\n$yuandan = $holidayService-\u003efind('元旦节'):\n \n echo $yuandan-\u003egetDate(); //输出 1月1日\n```\n\n### 民族查询\n\n```php\n\n$china = new China();\n\n$nationalityService = $chna-\u003egetNationality();\n\nprint_r($nationalityService-\u003efindAll());\n\n```\n\n按名称查找\n\n```php\n$hezhe = $nationalityService-\u003efind('赫哲族'):\n \n echo $hezhe-\u003egetPinyin(); //输出“hè zhé zú”\n echo $hezhe-\u003egetPopulation(); //输出人口\n```\n\n\n### 地址库查询\n\n\n```php\n\n$china = new China();\n\n$regionService = $china-\u003egetRegion();\n\nprint_r($regionService-\u003egetProvinces()); //获取树形省市县地区结构\n```\n\n按名称查找地区\n\n```php\n$bengbushi = $regionService-\u003efindByName('蚌埠市');\necho $bengbushi-\u003egetParent()-\u003egetName(); //输出蚌埠市所属省， 安徽省\n```\n\n查询身份证所在地\n\n```php\n$huaiyuan = $regionService-\u003efindByIdCard('340321199212026972');\n```\n\n地区链功能\n\n通过`AddressInterface`的`getParent()`和`getChildren()`方法你可以自由地查找当前地区的上级或者下级地区，下级地区集合是`RegionCollectionInterfaec`\n实例；\n\n```php\n$yuhuiqu = $bengbushi-\u003egetChildren()-\u003efindByName('禹会区'); //蚌埠市下属禹会区\n$yuhuiqu-\u003egetParent()-\u003egetChildren()-\u003efindByName('淮上区'); //禹会区同级淮上区\n```\nJson Serialize\n\n```php\n$bengbushi = $regionService-\u003efindByName('蚌埠市');\necho json_encode($bengbushi);\n```\n上述代码会输出蚌埠市及其下属地区的完整的json树形结构；如果你不需要的话下级地区的话请将children设置为空\n\n```php\n$bengbushi = $regionService-\u003efindByName('蚌埠市');\n$bengbushi = clone $bengbushi; //此处需要克隆对象，如果直接修改会破坏原有的地区树结构\n$bengbushi-\u003esetChildren([]);\necho json_encode($bengbushi);\n```\n\n\u003e 建议：在电商系统中城市县三级地区联动的数据可以使用此方法获取，避免将数据导入数据库再从数据库获取；\n\n\n## 命令行工具\n\n执行下面命令查看支持的所有命令\n\n```bash\n$ china list\n```\n输出信息：\n```\nAvailable commands:\n  help                   Displays help for a command\n  list                   Lists commands\n crawl\n  crawl:holiday          采集节假日数据\n  crawl:nationality      从百度百科采集民族信息\n  crawl:region           从国家统计局采集地区信息\n view\n  view:holiday      展示节假日信息\n  view:nationality  展示民族数据信息\n  view:region       展示我国省市县信息\n```\n\n例: 展示我国所有的省、直辖市、自治区以及特别行政区：\n\n```bash\n$ china  dashboard:region\n```\n上述命令会输出以下结果：\n\n```\n -------- ------------------ ------\n  Code     名称               类型\n -------- ------------------ ------\n  110000   北京市             省\n  120000   天津市             省\n  130000   河北省             省\n  140000   山西省             省\n  150000   内蒙古自治区       省\n  210000   辽宁省             省\n  220000   吉林省             省\n  230000   黑龙江省           省\n  310000   上海市             省\n  320000   江苏省             省\n  330000   浙江省             省\n  340000   安徽省             省\n  350000   福建省             省\n  360000   江西省             省\n  370000   山东省             省\n  410000   河南省             省\n  420000   湖北省             省\n  430000   湖南省             省\n  440000   广东省             省\n  450000   广西壮族自治区     省\n  460000   海南省             省\n  500000   重庆市             省\n  510000   四川省             省\n  520000   贵州省             省\n  530000   云南省             省\n  540000   西藏自治区         省\n  610000   陕西省             省\n  620000   甘肃省             省\n  630000   青海省             省\n  640000   宁夏回族自治区     省\n  650000   新疆维吾尔自治区   省\n  710000   台湾省             省\n  810000   香港特别行政区     省\n  820000   澳门特别行政区     省\n -------- ------------------ ------\n```\n...\n\n## License\n\nThe MIT license. See [MIT](https://opensource.org/licenses/MIT)\n\n\n\n\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslince%2Fchina","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fslince%2Fchina","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslince%2Fchina/lists"}