chabter/laravel-dutch-postalcode-lookup

Laravel wrapper to perform a Dutch postal code (postcode) lookup using the publicly available PDOK Locatieserver v3.

2.0 2021-02-20 21:07 UTC

This package is auto-updated.

Last update: 2021-11-20 22:58:26 UTC


README

PHP from Packagist Latest Version on Packagist Software License Total Downloads

This package is a Laravel wrapper of Nationaal Georegister provider for Geocoder PHP, which can be used to lookup a postal code to return the corresponding street and city.

The publicly available PDOK Locatieserver v3 (Dutch) is utilized to provide the necessary geodata.

Installation

Use composer to install this package:

$ composer require chabter/laravel-dutch-postalcode-lookup

Usage

Perform a lookup by postal code:

PostalCodeLookupService::lookup('1012JS');

Or perform a lookup by a postal code and house number combination:

PostalCodeLookupService::lookup('1012JS', 1);

The lookup method also supports using house number extensions as follows:

PostalCodeLookupService::lookup('1012JS', '5B');

Response

The lookup method returns a Chabter\PostalCodeLookup\Models\Address model on success, for example:

$address->getPostalCode() => '1012JS';
$address->getHouseNumber() => 1; // or string including housenumber extension
$address->getStreet() => 'Dam';
$address->getCity() => 'Amsterdam';

Testing

Run the tests with:

$ composer test

Support

Version Laravel Version PHP Version
2.x 8.x ^7.3|^8.0
1.x 7.x >=7.2

Version 1.x will also work with Laravel 8 if Guzzle 6 is available (^6.5|7.0 in composer.json).

Postcardware

This package is completely free to use. If it makes it to your production environment we would highly appreciate you sending us a postcard from your hometown! 👏🏼

Our address is: Chabter, Kanaalstraat 12B, 5347KM Oss, Netherlands.

License

The MIT License (MIT). Please see License File for more information.