maxh / php-nominatim
Wrapper for Nominatim API
Installs: 316 191
Dependents: 3
Suggesters: 0
Security: 0
Stars: 44
Watchers: 5
Forks: 17
Open Issues: 2
Requires
- php: >=7.3
- ext-mbstring: *
- guzzlehttp/guzzle: @stable
Requires (Dev)
- friendsofphp/php-cs-fixer: dev-master
- phpro/grumphp-shim: ^1.4
- phpunit/phpunit: ^8.5|^9.2
README
A simple interface to OSM Nominatim.
See Nominatim documentation for info on the service.
Installation
Install the package through composer:
composer require maxh/php-nominatim
Make sure, that you include the composer autoloader somewhere in your codebase.
Basic usage
Create a new instance of Nominatim.
use maxh\Nominatim\Nominatim; $url = "http://nominatim.openstreetmap.org/"; $nominatim = new Nominatim($url);
Searching by query :
$search = $nominatim->newSearch(); $search->query('HelloWorld'); $nominatim->find($search);
Or break it down by address :
$search = $nominatim->newSearch() ->country('France') ->city('Bayonne') ->postalCode('64100') ->polygon('geojson') //or 'kml', 'svg' and 'text' ->addressDetails(); $result = $nominatim->find($search);
Or do a reverse query :
$reverse = $nominatim->newReverse() ->latlon(43.4843941, -1.4960842); $result = $nominatim->find($reverse);
Or do a lookup query :
$lookup = $nominatim->newLookup() ->format('xml') ->osmIds('R146656,W104393803,N240109189') ->nameDetails(true); $result = $nominatim->find($lookup);
Or do a details query (by place_id):
$details = $nominatim->newDetails() ->placeId(1234) ->polygon('geojson'); $result = $nominatim->find($details);
Or do a details query (by osm type and osm id):
$details = $nominatim->newDetails() ->osmType('R') ->osmId(1234) ->polygon('geojson'); $result = $nominatim->find($details);
By default, the output format of the request is json and the wrapper return a array of results. It can be also xml, but the wrapper return a object SimpleXMLElement
How to override request header ?
There are two possibilities :
- By
Nominatim
instance, for all request :
$nominatim = new Nominatim($url, [ 'verify' => false ]);
- By
find
method, for a request :
$result = $nominatim->find($lookup, [ 'verify' => false ]);
How to customize HTTP client configuration ?
You can inject your own HTTP client with your specific configuration. For instance, you can edit user-agent and timeout for all your requests
<?php use maxh\Nominatim\Nominatim; use GuzzleHttp\Client; $url = "http://nominatim.openstreetmap.org/"; $defaultHeader = [ 'verify' => false, 'headers', array('User-Agent' => 'api_client') ]; $client = new Client([ 'base_uri' => $url, 'timeout' => 30, 'connection_timeout' => 5, ]); $nominatim = new Nominatim($url, $defaultHeader, $client);
Note
This projet was inpired by the Opendi/nominatim project with more features like reverse query, support of the xml format, customize HTTP client and more on which i work.
Recall Usage Policy Nominatim
If you use the service : http://nominatim.openstreetmap.org/, please see Nominatim usage policy.