Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/riverside/php-nominatim
:pushpin: PHP client for Nominatim, a search engine for OpenStreetMap data.
https://github.com/riverside/php-nominatim
address-lookup geocoding nominatim openstreetmap osm reverse-geocoding search-engine
Last synced: 3 months ago
JSON representation
:pushpin: PHP client for Nominatim, a search engine for OpenStreetMap data.
- Host: GitHub
- URL: https://github.com/riverside/php-nominatim
- Owner: riverside
- License: mit
- Created: 2020-01-06T20:18:04.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-15T09:47:15.000Z (4 months ago)
- Last Synced: 2024-09-30T05:02:22.724Z (4 months ago)
- Topics: address-lookup, geocoding, nominatim, openstreetmap, osm, reverse-geocoding, search-engine
- Language: PHP
- Homepage:
- Size: 49.8 KB
- Stars: 10
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# php-nominatim
A PHP client for Nominatim, the search engine for OpenStreetMap data.
| Build | Stable | License |
| --- | --- | --- |
| [](https://github.com/riverside/php-nominatim/actions/workflows/test.yml) | [](https://packagist.org/packages/riverside/php-nominatim) | [](https://packagist.org/packages/riverside/php-nominatim) |
### Installation
- If Composer is already installed
```
composer require riverside/php-nominatim
```
- If Composer is not installed on your system yet, you may go ahead and install it using this command line:
```
$ curl -sS https://getcomposer.org/installer | php
```
Next, add the following require entry to the composer.json file in the root of your project.
```json
{
"require" : {
"riverside/php-nominatim" : "^2.0"
}
}
```
Finally, use Composer to install php-nominatim and its dependencies:
```
$ php composer.phar install
```
### Loading
```php
require __DIR__ . '/vendor/autoload.php';
```
### Search (geocoding)
Look up a location from a textual description or address.
```php
$client = new \Riverside\Nominatim\Client();
try {
$response = $client->search('Madison Square Garden, NY');
if ($response->isOK()) {
echo $response->getLat(0) . ", " . $response->getLng(0);
} else {
echo 'Location not found.';
}
} catch (InvalidArgumentException $e) {
echo $e->getMessage();
} catch (Exception $e) {
echo $e->getMessage();
}
```
### Reverse geocoding
Generates an address from a latitude and longitude.
```php
$client = new \Riverside\Nominatim\Client();
try {
$response = $client->reverse(48.8539373, 2.2825966);
if ($response->isOK()) {
echo $response->getAddress(0);
} else {
echo 'Address not found';
}
} catch (InvalidArgumentException $e) {
echo $e->getMessage();
} catch (Exception $e) {
echo $e->getMessage();
}
```
### Address lookup
Query the address and other details of one or multiple OSM objects like node, way or relation.
```php
$client = new \Riverside\Nominatim\Client();
try {
$client->setAddressDetails(1);
$response = $client->lookup('R146656,W104393803,N240109189');
if ($response->isOK()) {
echo '
';
print_r($response->toArray());
} else {
echo 'Address not found';
}
} catch (InvalidArgumentException $e) {
echo $e->getMessage();
} catch (Exception $e) {
echo $e->getMessage();
}
```
### Place details
Show all details about a single place saved in the database.
```php
$client = new \Riverside\Nominatim\Client();
try {
$client->setAddressDetails(1);
$response = $client->details(199375150);
if ($response->isOK())
{
echo '
';
print_r($response->toArray());
} else {
echo 'Place not found';
}
} catch (InvalidArgumentException $e) {
echo $e->getMessage();
} catch (Exception $e) {
echo $e->getMessage();
}
```
### Status
Check if the service and database is running, and when the database was last updated.
```php
$client = new \Riverside\Nominatim\Client();
try {
$response = $client->status();
if ($response->isOK())
{
echo '
';
print_r($response->toArray());
} else {
echo 'Status not found';
}
} catch (InvalidArgumentException $e) {
echo $e->getMessage();
} catch (Exception $e) {
echo $e->getMessage();
}
```
### Deletable
List objects that have been deleted in OSM but are held back in Nominatim in case the deletion was accidental.
```php
$client = new \Riverside\Nominatim\Client();
try {
$response = $client->deletable();
if ($response->isOK())
{
echo '
';
print_r($response->toArray());
} else {
echo 'Deletable objects not found';
}
} catch (InvalidArgumentException $e) {
echo $e->getMessage();
} catch (Exception $e) {
echo $e->getMessage();
}
```
### Polygons
List of broken polygons detected by Nominatim.
```php
$client = new \Riverside\Nominatim\Client();
try {
$response = $client->polygons();
if ($response->isOK())
{
echo '
';
print_r($response->toArray());
} else {
echo 'Polygons not found';
}
} catch (InvalidArgumentException $e) {
echo $e->getMessage();
} catch (Exception $e) {
echo $e->getMessage();
}
```
### Links
- https://wiki.openstreetmap.org/wiki/Nominatim
- https://github.com/openstreetmap/Nominatim
- https://nominatim.openstreetmap.org/
- https://nominatim.org/