README

此库处理各种与英国邮政编码相关的任务。

功能

通过邮政编码查找地址
邮政编码验证
生成有效的英国邮政编码
获取邮政编码的外向和内向编码

安装

要安装，只需运行以下composer命令。

composer require rapidwebltd/php-postcodes

设置

邮政编码查找服务

使用此库提供的某些数据检索功能需要邮政编码查找服务。它目前支持以下邮政编码查找服务。

理想邮政编码 - https://ideal-postcodes.co.uk
邮政编码任意处（PCA Predict） - https://www.pcapredict.com/

如果您需要使用这些功能，请在相应的网站上注册。

然后，您可以使用以下代码获取适当的邮政编码查找服务对象。

$postcodeLookupService = new \RapidWeb\Postcodes\Objects\IdealPostcodes('API_KEY');
// OR
$postcodeLookupService = new \RapidWeb\Postcodes\Objects\PostcodeAnywhere('API_KEY');

用法

通过邮政编码获取地址

要检索与英国邮政编码关联的地址，只需将其传递到下面显示的方法中。您将收到一个地址对象数组，这些对象按地址行和其他细节适当分割。

$addresses = $postcodeLookupService->getAddressesByPostcode('ST163DP');

验证邮政编码

您可以使用Validator实用类来验证英国邮政编码是否正确。以下是如何做到这一点的示例。

$validated = \RapidWeb\Postcodes\Utils\Validator::validatePostcode('ST163DP');

请注意，邮政编码验证不区分大小写。

生成邮政编码

此库允许您生成一个随机、有效的英国邮政编码。这使用Generator实用类，如下所示。

$postcode = \RapidWeb\Postcodes\Utils\Generator::generatePostcode();

获取外向和内向编码

邮政编码的第一部分（例如PO1）称为外向编码，因为它标识了信件将被发送到哪个城镇或地区以进行进一步分拣。邮政编码的第二部分（例如1EB）称为内向编码。

$outwardCode = \RapidWeb\Postcodes\Utils\Tokenizer::outward('ST163JR'); // Returns ST16
$inwardCode = \RapidWeb\Postcodes\Utils\Tokenizer::inward('ST163JR'); // Returns 3JR

rapidwebltd / php-postcodes

维护者

详细信息