rickgoemans / dutch-province-postcode-helper
The helper package for dutch postcodes and province related stuff.
dev-master
2019-12-15 18:00 UTC
Requires
- php: ^7.2
Requires (Dev)
- phpunit/phpunit: ^8
This package is auto-updated.
Last update: 2024-10-16 05:32:15 UTC
README
This package helps you with common actions related to (Dutch) postcodes and provinces.
Source: https://nl.wikipedia.org/wiki/Postcodes_in_Nederland
Table of contents
1.0 Install
2.0 Usage
2.1 Get all provinces
2.2 Get all postcode numbers
2.3 Valid province
2.4 Valid postcode
2.5 Get province from postcode
2.6 Check postcode in province
3.0 Tests
4.0 Future expansions
1.0 Install
compose require rickgoemans/dutch-province-postcode-helper
2.0 Usage
Here are some examples of how to use this package.
2.1 Get all provinces
use DutchProvincePostcodeHelper\DutchProvincePostcodeHelper; $provinces = (new DutchProvincePostcodeHelper())->getProvinces();
2.2 Get all postcode numbers
use DutchProvincePostcodeHelper\DutchProvincePostcodeHelper; $provinces = (new DutchProvincePostcodeHelper())->getPostcodeNumbers();
2.3 Valid province
use DutchProvincePostcodeHelper\DutchProvincePostcodeHelper; if((new DutchProvincePostcodeHelper())->isValidProvince('Noord-Brabant')) { // valid } else { // invalid }
2.4 Valid postcode
use DutchProvincePostcodeHelper\DutchProvincePostcodeHelper; if((new DutchProvincePostcodeHelper())->isValidPostcode('5825 CP')) { // valid } else { // invalid }
2.5 Get province from postcode
use DutchProvincePostcodeHelper\DutchProvincePostcodeHelper; try { $province = (new DutchProvincePostcodeHelper())->getProvinceFromPostcode('5825 CP')); } catch (\DutchProvincePostcodeHelper\Exceptions\InvalidPostcode $e) { echo $e->getMessage(); }
2.6 Check postcode in province
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 Tests
You can execute PHPUnit tests by running;
./vendor/bin/phpunit --bootstrap vendor/autoload.php tests/DutchProvincePostcodeHelperTest.php
4.0 Future expansions
Nothing planned at the moment. Know of something useful to add? Post an issue!