Files
librenms-librenms/app/ApiClients/NominatimApi.php
Félix Bouynot b59cf980ca Type API methods and properties (#14476)
* Type properties

* Comment method

* Update base_uri child property

* Update BingApi.php

* Update GoogleMapsApi.php

* Update MapquestApi.php

* Update NominatimApi.php

* Update RipeApi.php

* Update phpstan-baseline.neon

* Update phpstan-baseline.neon

* Fix indent

* Fix escaping

* Update phpstan-baseline.neon

* Update phpstan-baseline.neon

* Update phpstan-baseline.neon

* Update phpstan-baseline.neon

* Update phpstan-baseline.neon

* Update phpstan-baseline.neon

* Update phpstan-baseline.neon

* Update phpstan-baseline.neon

* StyleCI indent

* Update phpstan-baseline.neon

* Make possible for $client to be null

* Remove comments

* Remove comments

* Remove comments

* Update MapquestApi.php

* Update NominatimApi.php

* Remove comments

* Remove comments

* $base_uri not nullable

* $base_uri not nullable

* $base_uri not nullable

* $base_uri not nullable

* $base_uri not nullable

* $base_uri not nullable

* Type method and properties

* Type method and properties

* Type method and properties

* Type method and properties

* Type method and properties

* Type method and properties

* Type $client

* Type method and properties

* Remove errors not matched anymore

* Fix type errors in graylogapi

* Mixed can't be ORed

* uri never null

* Update app/ApiClients/GraylogApi.php

* Fix getAdresses Type

* Collection changed its folder?

* Fix directory, there was just a backslash missing

Co-authored-by: Tony Murray <murraytony@gmail.com>
2022-11-02 01:06:15 +01:00

68 lines
1.9 KiB
PHP

<?php
/**
* NominatimApi.php
*
* -Description-
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
* @link https://www.librenms.org
*
* @copyright 2018 Tony Murray
* @author Tony Murray <murraytony@gmail.com>
*/
namespace App\ApiClients;
use LibreNMS\Interfaces\Geocoder;
class NominatimApi extends BaseApi implements Geocoder
{
use GeocodingHelper;
protected string $base_uri = 'https://nominatim.openstreetmap.org';
protected string $geocoding_uri = '/search';
/**
* Get latitude and longitude from geocode response
*/
protected function parseLatLng(array $data): array
{
return [
'lat' => isset($data[0]['lat']) ? $data[0]['lat'] : 0,
'lng' => isset($data[0]['lon']) ? $data[0]['lon'] : 0,
];
}
/**
* Build Guzzle request option array
*
* @throws \Exception you may throw an Exception if validation fails
*/
protected function buildGeocodingOptions(string $address): array
{
return [
'query' => [
'q' => $address,
'format' => 'json',
'limit' => 1,
],
'headers' => [
'User-Agent' => 'LibreNMS',
'Accept' => 'application/json',
],
];
}
}