brick/postcode

用于格式化和验证邮编的库

维护者

详细信息

github.com/brick/postcode

源代码

问题

资助包维护!
BenMorel

0.3.3 2024-09-19 22:43 UTC

This package is auto-updated.

Last update: 2024-09-19 23:10:48 UTC


README

一个用于验证和格式化邮编的PHP库。

Build Status Coverage Status Latest Stable Version Total Downloads License

简介

此库可以为具有邮编系统的所有国家格式化和验证邮编。

欢迎贡献,如果您发现任何错误,请随时提交问题或拉取请求。

安装

此库可以通过 Composer 安装。

composer require brick/postcode

要求

此库需要PHP 7.4或更高版本。

为了与PHP 7.1、7.2和7.3兼容,您可以使用版本 0.2。请注意,这些PHP版本已结束支持,不再受支持。如果您仍在使用这些PHP版本之一,您应考虑尽快升级。

项目状态和发布流程

此库仍在开发中。

当前版本号格式为 0.x.y。当引入非破坏性变更(添加新方法、优化现有代码等)时,y 将增加。

当引入破坏性变更时,总是从新的 0.x 版本周期开始。

因此,将您的项目锁定到给定的发布周期(如 0.3.*)是安全的。

如果您需要升级到新的发布周期,请查看 发布历史,以获取每个后续 0.x.0 版本引入的变更列表。

如何使用它

use Brick\Postcode\PostcodeFormatter;

$formatter = new PostcodeFormatter();

$formatter->format('GB', 'WC2E9RZ'); // WC2E 9RZ
$formatter->format('US', '337014313'); // 33701-4313

注意

  • 在验证之前,邮编会从可选的分隔符(空格和破折号)中清除。错位或不匹配的分隔符不会被视为错误,将被忽略

    $formatter->format('GB', 'WC-2E9RZ'); // WC2E 9RZ
  • 如果使用未知的国家代码调用 format(),则抛出 UnknownCountryException

    $formatter->format('XX', '12345'); // UnknownCountryException

    请注意,即使国家代码是有效的ISO 3166代码,没有邮编系统的国家也被视为未知。

  • 如果使用给定国家的无效邮编调用 format(),则抛出 InvalidPostcodeException

    $formatter->format('GB', 'ABCDEFG'); // InvalidPostcodeException