Covivo/mobicoop

<?php

/**
 * Copyright (c) 2022, MOBICOOP. All rights reserved.
 * This project is dual licensed under AGPL and proprietary licence.
 ***************************
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the GNU Affero 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 Affero General Public License for more details.
 *
 *    You should have received a copy of the GNU Affero General Public License
 *    along with this program.  If not, see <gnu.org/licenses>.
 ***************************
 *    Licence MOBICOOP described in the file
 *    LICENSE
 */

declare(strict_types=1);

namespace App\Geography\Service\Geocoder;

interface Geocoder
{
    public function setPrioritizeCentroid(float $lon, float $lat): void;

    public function setPrioritizeBox(float $minLon, float $minLat, float $maxLon, float $maxLat): void;

    public function setPrioritizeRegion(string $region): void;

    public function setRestrictCountry(string $country): void;

    public function setLang(string $lang): void;

    /**
     * @return array
     *               [
     *               'country',
     *               'country_code',
     *               'distance',
     *               'house_number',
     *               'id',
     *               'lat',
     *               'locality',
     *               'locality_code',
     *               'lon',
     *               'macro_region',
     *               'name',
     *               'population',
     *               'postal_code',
     *               'region',
     *               'region_code',
     *               'street_name',
     *               'type',
     *               'provider'
     *               ]
     * */
    public function geocode(string $search): array;

    public function reverse(float $lon, float $lat): array;
}