forked from geocoder-php/Geocoder
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathProviderInterface.php
More file actions
63 lines (56 loc) · 1.72 KB
/
Copy pathProviderInterface.php
File metadata and controls
63 lines (56 loc) · 1.72 KB
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
57
58
59
60
61
62
63
<?php
/**
* 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\Provider;
use Geocoder\Exception\NoResultException;
use Geocoder\Exception\InvalidCredentialsException;
use Geocoder\Exception\UnsupportedException;
/**
* @author William Durand <william.durand1@gmail.com>
*/
interface ProviderInterface
{
/**
* Returns an associative array with data treated by the provider.
*
* @param string $address An address (IP or street).
*
* @throws NoResultException If the address could not be resolved
* @throws InvalidCredentialsException If the credentials are invalid
* @throws UnsupportedException If IPv4, IPv6 or street is not supported
*
* @return array
*/
public function getGeocodedData($address);
/**
* Returns an associative array with data treated by the provider.
*
* @param array $coordinates Coordinates (latitude, longitude).
*
* @throws NoResultException If the coordinates could not be resolved
* @throws InvalidCredentialsException If the credentials are invalid
* @throws UnsupportedException If reverse geocoding is not supported
*
* @return array
*/
public function getReversedData(array $coordinates);
/**
* Returns the provider's name.
*
* @return string
*/
public function getName();
/**
* Sets the maximum number of returned results.
*
* @param integer $maxResults
*
* @return ProviderInterface
*/
public function setMaxResults($maxResults);
}