forked from geocoder-php/Geocoder
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathResultInterface.php
More file actions
153 lines (133 loc) · 2.67 KB
/
Copy pathResultInterface.php
File metadata and controls
153 lines (133 loc) · 2.67 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
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
<?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\Result;
/**
* @author William Durand <william.durand1@gmail.com>
*/
interface ResultInterface
{
/**
* Returns an array of coordinates (latitude, longitude).
*
* @return array
*/
public function getCoordinates();
/**
* Returns the latitude value.
*
* @return double
*/
public function getLatitude();
/**
* Returns the longitude value.
*
* @return double
*/
public function getLongitude();
/**
* Returns the bounds value.
*
* Bounds format:
*
* array(
* 'south' => (double)
* 'west' => (double)
* 'north' => (double)
* 'east' => (double)
* )
*
* @return array
*/
public function getBounds();
/**
* Returns the street number value.
*
* @return string|int
*/
public function getStreetNumber();
/**
* Returns the street name value.
*
* @return string
*/
public function getStreetName();
/**
* Returns the city value.
*
* @return string
*/
public function getCity();
/**
* Returns the zipcode value.
*
* @return string
*/
public function getZipcode();
/**
* Returns the city district, or
* sublocality, or neighborhood.
*
* @return string
*/
public function getCityDistrict();
/**
* Returns the county value.
*
* @return string
*/
public function getCounty();
/**
* Returns the county short name.
*
* @return string
*/
public function getCountyCode();
/**
* Returns the region value.
*
* @return string
*/
public function getRegion();
/**
* Returns the region short name.
*
* @return string
*/
public function getRegionCode();
/**
* Returns the country value.
*
* @return string
*/
public function getCountry();
/**
* Returns the country ISO code.
*
* @return string
*/
public function getCountryCode();
/**
* Returns the timezone.
*
* @return string
*/
public function getTimezone();
/**
* Extracts data from an array.
*
* @param array $data An array.
*/
public function fromArray(array $data = array());
/**
* Returns an array with data indexed by name.
*
* @return array
*/
public function toArray();
}