README

此包可以帮助您处理与（荷兰）邮政编码和省相关的一些常用操作。
来源：https://nl.wikipedia.org/wiki/Postcodes_in_Nederland

目录

1.0 安装
2.0 使用
2.1 获取所有省份
2.2 获取所有邮政编码号码
2.3 有效省份
2.4 有效邮政编码
2.5 从邮政编码获取省份
2.6 检查邮政编码是否在省份中
3.0 测试
4.0 未来扩展

1.0 安装

compose require rickgoemans/dutch-province-postcode-helper

2.0 使用

以下是一些使用此包的示例。

2.1 获取所有省份

use DutchProvincePostcodeHelper\DutchProvincePostcodeHelper;

$provinces = (new DutchProvincePostcodeHelper())->getProvinces();

2.2 获取所有邮政编码号码

use DutchProvincePostcodeHelper\DutchProvincePostcodeHelper;

$provinces = (new DutchProvincePostcodeHelper())->getPostcodeNumbers();

2.3 有效省份

use DutchProvincePostcodeHelper\DutchProvincePostcodeHelper;

if((new DutchProvincePostcodeHelper())->isValidProvince('Noord-Brabant')) {
    // valid 
} else {
    // invalid
}

2.4 有效邮政编码

use DutchProvincePostcodeHelper\DutchProvincePostcodeHelper;

if((new DutchProvincePostcodeHelper())->isValidPostcode('5825 CP')) {
    // valid 
} else {
    // invalid
}

2.5 从邮政编码获取省份

use DutchProvincePostcodeHelper\DutchProvincePostcodeHelper;

try {
    $province = (new DutchProvincePostcodeHelper())->getProvinceFromPostcode('5825 CP'));
} catch (\DutchProvincePostcodeHelper\Exceptions\InvalidPostcode $e) {
    echo $e->getMessage();
}

2.6 检查邮政编码是否在省份中

use DutchProvincePostcodeHelper\DutchProvincePostcodeHelper;

try {
    if((new DutchProvincePostcodeHelper())isPostcodeInProvince('5825 CP', 'Noord-Brabant'))) {
        // true
    } else {
        // false
    }
} catch (\DutchProvincePostcodeHelper\Exceptions\InvalidPostcode $e) {
    echo $e->getMessage();
}

3.0 测试

您可以通过运行；来执行PHPUnit测试

./vendor/bin/phpunit --bootstrap vendor/autoload.php tests/DutchProvincePostcodeHelperTest.php

4.0 未来扩展

目前没有计划。知道有什么有用的功能可以添加吗？请提交一个问题！