naisi_region_get

查看 Markdown

按共用编码获取地区及完整父级链,包含数据库保留的删除记录。 region_type 是国内/国际数据集整数标识;region_kind、level 直接读取数据库,不根据编码或树深度推断。 国内编码使用行政区划记录;籍贯复用这些编码。name 为对应源表原始名称,国际 name 为官方语言名称。 国内另含 short_name、pinyin、pinyin_short;国际另含 en_name、zh_name、numeric,不返回不存在的简称。 numeric 为三位数字字符串(例如 "004"),只在国际顶层返回。国内不返回 is_extension。 parents 从最上级到直接父级排列,含 region_code、parent_code、region_kind、level、name 和对应名称/拼音字段; 不含 region_type、numeric、is_deleted 或嵌套 parents;根节点 parents=[]。空名称原样返回,不替换字段。 使用 UTF-8 数据;调用前须建立本请求有效许可状态。

函数签名

function naisi_region_get(int $region_code): array|false

调用前提

应用入口先调用 naisi_is_ext_license_valid 并确认返回 true。只验证同一请求内已有的有效 FULL/BASIC 证明;没有证明或证明失效时立即返回失败值,不现场补做完整校验。

授权类别:LICENSE;执行模式:PROOF。许可不代替登录、租户或权限上下文;身份与数据要求见本页参数及用途说明。

参数

$region_code

  • 类型:int
  • 必填:是
  • 默认值:无
  • 方向:输入参数。

地区共用整数编码;国内按行政区划查询。

返回值

类型:array{region_code:int,parent_code:int,region_type:int,region_kind:string,level:int,name:string,is_deleted:bool,parents:array}|false

不存在、未授权或加载失败返回 false。

调用示例

当前请求须满足上方调用前提;请检查实际返回值和引用输出,随机结果及数据包内容以运行环境为准。

$region_code = 361104;

$result = naisi_region_get($region_code);
var_export($result);

编码与异常

籍贯与国内行政区划共用编码。get/code_to_name 不增加类型参数,国内编码使用行政区划名称和父链;列表、搜索、名称解析按传入类型选择数据。get/code_to_name 可读取库中仍保留的软删除记录,其余接口过滤软删除记录;物理删除的历史记录无法查询。

参数必须与签名声明的原始 PHP 类型一致,不做弱类型转换;类型不匹配返回 false。参数数量错误仍遵循 PHP 标准异常规则。文本使用 UTF-8,地区文本及分隔符最多 4096 字节,不允许 NUL。没有引用输出参数。

版本信息

  • 实现模块:region
  • 授权类别:LICENSE / PROOF
  • 失败回退:false
  • 文档同步:2026-10-18