summaryrefslogtreecommitdiff
path: root/www/wiki/vendor/willdurand/geocoder/Geocoder.php
blob: d52e1f3b1335327daa1ad8c6716a5d0e5ba26564 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
<?php

declare(strict_types=1);

/*
 * This file is part of the Geocoder package.
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @license    MIT License
 */

namespace Geocoder;

use Geocoder\Provider\Provider;

/**
 * @author William Durand <william.durand1@gmail.com>
 */
interface Geocoder extends Provider
{
    /**
     * Version of this package.
     */
    const MAJOR_VERSION = 4;

    const VERSION = '4.0';

    /**
     * The default result limit.
     */
    const DEFAULT_RESULT_LIMIT = 5;

    /**
     * Geocodes a given value.
     *
     * @param string $value
     *
     * @return Collection
     *
     * @throws \Geocoder\Exception\Exception
     */
    public function geocode(string $value): Collection;

    /**
     * Reverses geocode given latitude and longitude values.
     *
     * @param float $latitude
     * @param float $longitude
     *
     * @return Collection
     *
     * @throws \Geocoder\Exception\Exception
     */
    public function reverse(float $latitude, float $longitude): Collection;
}