LeKoala\GeoTools\Services\Nominatim

Complexity

Total Complexity

10

Size/Duplication

Total Lines	114
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	query()	0	82	8
A	reverseGeocode()	0	6	1
A	geocode()	0	3	1

<?php

namespace LeKoala\GeoTools\Services;

use Exception;
use LeKoala\GeoTools\Models\Address;
use LeKoala\GeoTools\Models\Country;
use LeKoala\GeoTools\Models\Coordinates;
use SilverStripe\Control\Email\Email;

/**
 * @link https://wiki.openstreetmap.org/wiki/Nominatim
 * @link https://github.com/maxhelias/php-nominatim
 */
class Nominatim implements Geocoder
{
    const API_URL = 'https://nominatim.openstreetmap.org/{service}';
    const SEARCH_SERVICE = 'search';
    const REVERSE_SERVICE = 'reverse';
    const LOOKUP_SERVICE = 'lookup';

    /**
     * @param ?string $query
     * @param array<int|string,mixed> $params countrycodes
     * @return Address
     * @throws Exception when there is a problem with the api, otherwise may return an empty address
     */
    protected function query($query, $params = [])
    {
        $service = self::SEARCH_SERVICE;
        if (isset($params['service'])) {
            $service = $params['service'];
            unset($params['service']);
        }

        if ($query) {
            $params['q'] = $query;
        }

        $url = self::API_URL;
        $url = str_replace('{service}', $service, $url);

        $defaultParams = [
            'email' => Email::config()->admin_email,
            'limit' => 1,
            'format' => 'jsonv2',
            'addressdetails' => 1
        ];

        $params = array_merge($defaultParams, $params);

        $url .= '?' . http_build_query($params);

        // Create a stream
        $opts = [
            "http" => [
                "method" => "GET",
                "header" => implode("\r\n", [
                    "Accept: application/json",
                    "Accept-Encoding: gzip, deflate, br",
                    "Accept-Language: en",
                    "Cache-Control: no-cache",
                    "Pragma: no-cache",
                    "User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36",
                ])
            ]
        ];
        $context = stream_context_create($opts);
        $result = file_get_contents($url, false, $context);
        if (!$result) {
            throw new Exception("The api returned no result");
        }

        $data = json_decode($result, true);
        if (!$data) {
            throw new Exception("Failed to decode api results");
        }

        $location = [];
        $countryCode = $countryName = null;
        $lat = $lon = null;

        // in reverse geocoding, it's only one result
        if (isset($data['place_id'])) {
            $row = $data;
        } else {
            $row = $data[0];
        }

        if (isset($row['address'])) {
            $address = $row['address'];
            $location = [
                'streetName' => $address['road'] ?? $address['building'] ?? null,
                'streetNumber' => $address['house_number'] ?? null,
                'postalCode' => $address['postcode'] ?? null,
                'locality' => $address['city'] ?? null,
            ];
            $countryCode = $address['country_code'] ?? null;
            $countryName = $address['country'] ?? null;
        }
        if (!empty($row['lat'])) {
            $lat = $row['lat'];
            $lon = $row['lon'];
        }

        $country = new Country($countryCode, $countryName);
        $coordinates = new Coordinates($lat, $lon);

        return new Address($location, $country, $coordinates);
    }

    /**
     * @inheritDoc
     */
    public function reverseGeocode($lat, $lon, $params = [])
    {
        $params['service'] = self::REVERSE_SERVICE;
        $params['lat'] = $lat;
        $params['lon'] = $lon;
        return $this->query(null, $params);
    }

    /**
     * @inheritDoc
     */
    public function geocode($address, $params = [])
    {
        return $this->query($address, $params);
    }
}