blob: 5d9b9e44d35fca4ba71a1119051b47ecc7e8fdd0 (
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
<?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\Model\AdminLevelCollection;
use Geocoder\Model\Bounds;
use Geocoder\Model\Coordinates;
use Geocoder\Model\Country;
/**
* A location is a single result from a Geocoder.
*
* @author William Durand <william.durand1@gmail.com>
* @author Tobias Nyholm <tobias.nyholm@gmail.com>
*/
interface Location
{
/**
* Will always return the coordinates value object.
*
* @return Coordinates|null
*/
public function getCoordinates();
/**
* Returns the bounds value object.
*
* @return Bounds|null
*/
public function getBounds();
/**
* Returns the street number value.
*
* @return string|int|null
*/
public function getStreetNumber();
/**
* Returns the street name value.
*
* @return string|null
*/
public function getStreetName();
/**
* Returns the city or locality value.
*
* @return string|null
*/
public function getLocality();
/**
* Returns the postal code or zipcode value.
*
* @return string|null
*/
public function getPostalCode();
/**
* Returns the locality district, or
* sublocality, or neighborhood.
*
* @return string|null
*/
public function getSubLocality();
/**
* Returns the administrative levels.
*
* This method MUST NOT return null.
*
* @return AdminLevelCollection
*/
public function getAdminLevels(): AdminLevelCollection;
/**
* Returns the country value object.
*
* @return Country|null
*/
public function getCountry();
/**
* Returns the timezone for the Location. The timezone MUST be in the list of supported timezones.
*
* {@link http://php.net/manual/en/timezones.php}
*
* @return string|null
*/
public function getTimezone();
/**
* Returns an array with data indexed by name.
*
* @return array
*/
public function toArray(): array;
/**
* The name of the provider that created this Location.
*
* @return string
*/
public function getProvidedBy(): string;
}
|
