Nationaal Georegister provider for Geocoder PHP
Switch branches/tags
Nothing to show
Clone or download
Latest commit 32c8210 Oct 29, 2018

README.md

Nationaal Georegister provider for Geocoder PHP

PHP from Packagist Latest Version on Packagist Software License Run Status Coverage Badge Total Downloads Made by SWIS

This is the Nationaal Georegister provider for the PHP Geocoder, which uses the PDOK Locatieserver v3 (Dutch). It can geocode addresses (not IP addresses) and reverse geocode coordinates.

Please note that this provider can only (reverse) geocode addresses in The Netherlands!

Install

Via Composer

$ composer require swisnl/geocoder-php-nationaal-georegister-provider

HTTP Client

PHP Geocoder is decoupled from any HTTP messaging client with the help of PHP-HTTP. This requires another package providing php-http/client-implementation. To use Guzzle 6, for example, simply require php-http/guzzle6-adapter:

$ composer require php-http/guzzle6-adapter

Usage

// Create geocoder
$client = new \Http\Client\Curl\Client();
$geocoder = new \Swis\Geocoder\NationaalGeoregister\NationaalGeoregister($client);

// Geocode!
$query = \Geocoder\Query\GeocodeQuery::create(...);
$result = $geocoder->geocodeQuery($query);

Please see PHP Geocoder documentation for more information about using PHP Geocoder with this provider.

Options

This provider accepts extra options as the second argument. These options are directly passed to the Locatieserver, which accepts the following options:

Option Description Default Customizable in this provider
bq Boost query "type:gemeente^0.5 type:woonplaats^0.5 type:weg^1.0 type:postcode^1.5 type:adres^1.5" yes
df Default field - yes
fl Field list All fields used by this provider no
fq Filter query "type:adres" when reverse geocoding only for geocoding
lat&lon Latitude and longitude Coordinates from \Geocoder\Query\ReverseQuery when reverse geocoding only for geocoding
q Search term Text from \Geocoder\Query\GeocodeQuery when geocoding only for reverse geocoding
rows Amount of rows Limit from query no
start Page (starting at 0) - yes
sort Sorting See Locatieserver documentation (Dutch) yes
wt Format JSON no

These options correspond with the options mentioned in the Locatieserver documentation (Dutch), which describes them in more detail.

Example using extra options:

$client = new \Http\Client\Curl\Client();
$options = ['fq' => 'bron:BAG'];
$geocoder = new \Swis\Geocoder\NationaalGeoregister\NationaalGeoregister($client, $options);

Response

The geocoder returns a \Geocoder\Model\AddressCollection which is a collection of \Geocoder\Model\Address.

Example response (first \Geocoder\Model\Address from collection) for query "3e Binnenvestgracht 23T1, Leiden" using this provider:

$address->getCoordinates() => \Geocoder\Model\Coordinates
$address->getLatitude() => 52.164203
$address->getLongitude() => 4.49202289
$address->getBounds() => null (unavailable)
$address->getStreetNumber() => '23T-1'
$address->getStreetName() => '3e Binnenvestgracht'
$address->getPostalCode() => '2312NR'
$address->getLocality() => 'Leiden'
$address->getSubLocality() => null (unavailable)
$address->getAdminLevels()->get(2)->getName() => 'Leiden'
$address->getAdminLevels()->get(2)->getCode() => '0546'
$address->getAdminLevels()->get(1)->getName() => 'Zuid-Holland'
$address->getAdminLevels()->get(1)->getCode() => 'PV28'
$address->getCountry() => 'Netherlands' (static)
$address->getCountryCode() => 'NL' (static)
$address->getTimezone() => 'Europe/Amsterdam' (static)

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email security@swis.nl instead of using the issue tracker.

Credits

License

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