1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
declare(strict_types=1); |
4
|
|
|
|
5
|
|
|
/* |
6
|
|
|
* This file is part of the Geocoder package. |
7
|
|
|
* For the full copyright and license information, please view the LICENSE |
8
|
|
|
* file that was distributed with this source code. |
9
|
|
|
* |
10
|
|
|
* @license MIT License |
11
|
|
|
*/ |
12
|
|
|
|
13
|
|
|
namespace Geocoder\Provider\Nominatim\Model; |
14
|
|
|
|
15
|
|
|
use Geocoder\Model\Address; |
16
|
|
|
|
17
|
|
|
/** |
18
|
|
|
* @author Jonathan Beliën <[email protected]> |
19
|
|
|
*/ |
20
|
|
|
final class NominatimAddress extends Address |
21
|
|
|
{ |
22
|
|
|
/** |
23
|
|
|
* @var string|null |
24
|
|
|
*/ |
25
|
|
|
private $attribution; |
26
|
|
|
|
27
|
|
|
/** |
28
|
|
|
* @var string|null |
29
|
|
|
*/ |
30
|
|
|
private $category; |
31
|
|
|
|
32
|
|
|
/** |
33
|
|
|
* @var string|null |
34
|
|
|
*/ |
35
|
|
|
private $displayName; |
36
|
|
|
|
37
|
|
|
/** |
38
|
|
|
* @var string|null |
39
|
|
|
*/ |
40
|
|
|
private $quarter; |
41
|
|
|
|
42
|
|
|
/** |
43
|
|
|
* @var string|null |
44
|
|
|
*/ |
45
|
|
|
private $osmType; |
46
|
|
|
|
47
|
|
|
/** |
48
|
|
|
* @var int|null |
49
|
|
|
*/ |
50
|
|
|
private $osmId; |
51
|
|
|
|
52
|
|
|
/** |
53
|
|
|
* @var string|null |
54
|
|
|
*/ |
55
|
4 |
|
private $type; |
56
|
|
|
|
57
|
4 |
|
/** |
58
|
|
|
* @return string|null |
59
|
|
|
*/ |
60
|
|
|
public function getAttribution() |
61
|
|
|
{ |
62
|
|
|
return $this->attribution; |
63
|
|
|
} |
64
|
|
|
|
65
|
8 |
|
/** |
66
|
|
|
* @param string|null $attribution |
67
|
8 |
|
* |
68
|
8 |
|
* @return NominatimAddress |
69
|
|
|
*/ |
70
|
8 |
|
public function withAttribution(string $attribution = null): self |
71
|
|
|
{ |
72
|
|
|
$new = clone $this; |
73
|
|
|
$new->attribution = $attribution; |
74
|
|
|
|
75
|
|
|
return $new; |
76
|
|
|
} |
77
|
|
|
|
78
|
|
|
/** |
79
|
|
|
* @deprecated |
80
|
|
|
* |
81
|
|
|
* @return string|null |
82
|
|
|
*/ |
83
|
|
|
public function getClass() |
84
|
|
|
{ |
85
|
|
|
return $this->getCategory(); |
86
|
|
|
} |
87
|
|
|
|
88
|
|
|
/** |
89
|
|
|
* @deprecated |
90
|
|
|
* |
91
|
|
|
* @param string|null $category |
92
|
|
|
* |
93
|
|
|
* @return NominatimAddress |
94
|
|
|
*/ |
95
|
|
|
public function withClass(string $category = null): self |
96
|
|
|
{ |
97
|
|
|
return $this->withCategory($category); |
98
|
4 |
|
} |
99
|
|
|
|
100
|
4 |
|
/** |
101
|
|
|
* @return string|null |
102
|
|
|
*/ |
103
|
|
|
public function getCategory() |
104
|
|
|
{ |
105
|
|
|
return $this->category; |
106
|
|
|
} |
107
|
|
|
|
108
|
6 |
|
/** |
109
|
|
|
* @param string|null $category |
110
|
6 |
|
* |
111
|
6 |
|
* @return NominatimAddress |
112
|
|
|
*/ |
113
|
6 |
|
public function withCategory(string $category = null): self |
114
|
|
|
{ |
115
|
|
|
$new = clone $this; |
116
|
|
|
$new->category = $category; |
117
|
|
|
|
118
|
|
|
return $new; |
119
|
3 |
|
} |
120
|
|
|
|
121
|
3 |
|
/** |
122
|
|
|
* @return string|null |
123
|
|
|
*/ |
124
|
|
|
public function getDisplayName() |
125
|
|
|
{ |
126
|
|
|
return $this->displayName; |
127
|
|
|
} |
128
|
|
|
|
129
|
8 |
|
/** |
130
|
|
|
* @param string|null $displayName |
131
|
8 |
|
* |
132
|
8 |
|
* @return NominatimAddress |
133
|
|
|
*/ |
134
|
8 |
|
public function withDisplayName(string $displayName = null): self |
135
|
|
|
{ |
136
|
|
|
$new = clone $this; |
137
|
|
|
$new->displayName = $displayName; |
138
|
|
|
|
139
|
|
|
return $new; |
140
|
4 |
|
} |
141
|
|
|
|
142
|
4 |
|
/** |
143
|
|
|
* @return int|null |
144
|
|
|
*/ |
145
|
|
|
public function getOSMId() |
146
|
|
|
{ |
147
|
|
|
return $this->osmId; |
148
|
|
|
} |
149
|
|
|
|
150
|
7 |
|
/** |
151
|
|
|
* @param int|null $osmId |
152
|
7 |
|
* |
153
|
7 |
|
* @return NominatimAddress |
154
|
|
|
*/ |
155
|
7 |
|
public function withOSMId(int $osmId = null): self |
156
|
|
|
{ |
157
|
|
|
$new = clone $this; |
158
|
|
|
$new->osmId = $osmId; |
159
|
|
|
|
160
|
|
|
return $new; |
161
|
4 |
|
} |
162
|
|
|
|
163
|
4 |
|
/** |
164
|
|
|
* @return string|null |
165
|
|
|
*/ |
166
|
|
|
public function getOSMType() |
167
|
|
|
{ |
168
|
|
|
return $this->osmType; |
169
|
|
|
} |
170
|
|
|
|
171
|
7 |
|
/** |
172
|
|
|
* @param string|null $osmType |
173
|
7 |
|
* |
174
|
7 |
|
* @return NominatimAddress |
175
|
|
|
*/ |
176
|
7 |
|
public function withOSMType(string $osmType = null): self |
177
|
|
|
{ |
178
|
|
|
$new = clone $this; |
179
|
|
|
$new->osmType = $osmType; |
180
|
|
|
|
181
|
|
|
return $new; |
182
|
3 |
|
} |
183
|
|
|
|
184
|
3 |
|
/** |
185
|
|
|
* @return string|null |
186
|
|
|
*/ |
187
|
|
|
public function getType() |
188
|
|
|
{ |
189
|
|
|
return $this->type; |
190
|
|
|
} |
191
|
|
|
|
192
|
6 |
|
/** |
193
|
|
|
* @param string|null $type |
194
|
6 |
|
* |
195
|
6 |
|
* @return NominatimAddress |
196
|
|
|
*/ |
197
|
6 |
|
public function withType(string $type = null): self |
198
|
|
|
{ |
199
|
|
|
$new = clone $this; |
200
|
|
|
$new->type = $type; |
201
|
|
|
|
202
|
|
|
return $new; |
203
|
|
|
} |
204
|
|
|
|
205
|
|
|
/** |
206
|
|
|
* @return string|null |
207
|
|
|
*/ |
208
|
|
|
public function getQuarter(): ?string |
209
|
|
|
{ |
210
|
|
|
return $this->quarter; |
211
|
|
|
} |
212
|
|
|
|
213
|
|
|
/** |
214
|
|
|
* @param string|null $quarter |
215
|
|
|
* |
216
|
|
|
* @return NominatimAddress |
217
|
|
|
*/ |
218
|
|
|
public function withQuarter(string $quarter = null): self |
219
|
|
|
{ |
220
|
|
|
$new = clone $this; |
221
|
|
|
$new->quarter = $quarter; |
222
|
|
|
|
223
|
|
|
return $new; |
224
|
|
|
} |
225
|
|
|
} |
226
|
|
|
|