README

简单的 OSM Nominatim 接口。

有关服务的信息，请参阅 Nominatim 文档。

安装

通过 composer 安装包

composer require jbohme/nominatim-laravel

您必须使用以下配置发布项目

php artisan vendor:publish
php artisan config:cache

之后，文件 config/nominatim.php 就准备好了。

如果您打算使用自定义 URL，则必须在 .env 中包含 NOMINATIM_URL 参数

基本用法

创建一个新的 Nominatim 实例。

use NominatimLaravel\Content\Nominatim;

$url = "http://nominatim.openstreetmap.org/";
$nominatim = new Nominatim($url);

通过查询进行搜索

$search = $nominatim->newSearch();
$search->query('HelloWorld');

$nominatim->find($search);

或通过地址进行分解

$search = $nominatim->newSearch()
            ->country('France')
            ->city('Bayonne')
            ->postalCode('64100')
            ->polygon('geojson')    //or 'kml', 'svg' and 'text'
            ->addressDetails();

$result = $nominatim->find($search);

或进行反向查询

$reverse = $nominatim->newReverse()
            ->latlon(43.4843941, -1.4960842);

$result = $nominatim->find($reverse);

或进行查找查询

$lookup = $nominatim->newLookup()
            ->format('xml')
            ->osmIds('R146656,W104393803,N240109189')
            ->nameDetails(true);

$result = $nominatim->find($lookup);

或通过 place_id 进行详细查询

$details = $nominatim->newDetails()
            ->placeId(1234)
            ->polygon('geojson');

$result = $nominatim->find($details);

或通过 osm 类型和 osm id 进行详细查询

$details = $nominatim->newDetails()
            ->osmType('R')
            ->osmId(1234)
            ->polygon('geojson');

$result = $nominatim->find($details);

默认情况下，请求的输出格式为 json，包装器返回一个结果数组。它也可以是 xml，但包装器返回一个 SimpleXMLElement 对象

如何覆盖请求头？

有两种可能性

1. 通过 Nominatim 实例，对所有请求

$nominatim = new Nominatim($url, [
    'verify' => false
]);

1. 通过 find 方法，对单个请求

$result = $nominatim->find($lookup, [
    'verify' => false
]);

如何自定义 HTTP 客户端配置？

您可以使用自己的具有特定配置的 HTTP 客户端。例如，您可以编辑所有请求的用户代理和超时

<?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);

注意

该项目受到了 maxhelias/php-nominatim 的启发。代码已被调整以符合 Laravel 标准以用于未来的实现。

回顾 Nominatim 使用政策

如果您使用该服务： http://nominatim.openstreetmap.org/，请参阅 Nominatim 使用政策。