forked from geocoder-php/Geocoder
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathOpenCage.php
More file actions
211 lines (176 loc) · 6.16 KB
/
Copy pathOpenCage.php
File metadata and controls
211 lines (176 loc) · 6.16 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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
<?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\InvalidCredentials;
use Geocoder\Exception\NoResult;
use Geocoder\Exception\UnsupportedOperation;
use Ivory\HttpAdapter\HttpAdapterInterface;
/**
* @author mtm <mtm@opencagedata.com>
*/
class OpenCage extends AbstractHttpProvider implements LocaleAwareProvider
{
/**
* @var string
*/
const GEOCODE_ENDPOINT_URL = '%s://api.opencagedata.com/geocode/v1/json?key=%s&query=%s&limit=%d&pretty=1';
use LocaleTrait;
/**
* @var string
*/
private $scheme;
/**
* @var string
*/
private $apiKey;
/**
* @param HttpAdapterInterface $adapter An HTTP adapter.
* @param string $apiKey An API key.
* @param bool $useSsl Whether to use an SSL connection (optional).
* @param string|null $locale A locale (optional).
*/
public function __construct(HttpAdapterInterface $adapter, $apiKey, $useSsl = false, $locale = null)
{
parent::__construct($adapter);
$this->apiKey = $apiKey;
$this->scheme = $useSsl ? 'https' : 'http';
$this->locale = $locale;
}
/**
* {@inheritdoc}
*/
public function geocode($address)
{
if (null === $this->apiKey) {
throw new InvalidCredentials('No API Key provided.');
}
// This API doesn't handle IPs
if (filter_var($address, FILTER_VALIDATE_IP)) {
throw new UnsupportedOperation('The OpenCage provider does not support IP addresses, only street addresses.');
}
$query = sprintf(self::GEOCODE_ENDPOINT_URL, $this->scheme, $this->apiKey, urlencode($address), $this->getLimit());
return $this->executeQuery($query);
}
/**
* {@inheritdoc}
*/
public function reverse($latitude, $longitude)
{
$address = sprintf('%f, %f', $latitude, $longitude);
return $this->geocode($address);
}
/**
* {@inheritdoc}
*/
public function getName()
{
return 'opencage';
}
/**
* @param $query
* @return \Geocoder\Model\AddressCollection
*/
private function executeQuery($query)
{
if (null !== $this->getLocale()) {
$query = sprintf('%s&language=%s', $query, $this->getLocale());
}
$content = (string) $this->getAdapter()->get($query)->getBody();
if (empty($content)) {
throw new NoResult(sprintf('Could not execute query "%s".', $query));
}
$json = json_decode($content, true);
if (!isset($json['total_results']) || $json['total_results'] == 0) {
throw new NoResult(sprintf('Could not find results for query "%s".', $query));
}
$locations = $json['results'];
if (empty($locations)) {
throw new NoResult(sprintf('Could not find results for query "%s".', $query));
}
$results = [];
foreach ($locations as $location) {
$bounds = [];
if (isset($location['bounds'])) {
$bounds = [
'south' => $location['bounds']['southwest']['lat'],
'west' => $location['bounds']['southwest']['lng'],
'north' => $location['bounds']['northeast']['lat'],
'east' => $location['bounds']['northeast']['lng'],
];
}
$comp = $location['components'];
$adminLevels = [];
foreach (['state', 'county'] as $i => $component) {
if (isset($comp[$component])) {
$adminLevels[] = ['name' => $comp[$component], 'level' => $i + 1];
}
}
$results[] = array_merge($this->getDefaults(), array(
'latitude' => $location['geometry']['lat'],
'longitude' => $location['geometry']['lng'],
'bounds' => $bounds ?: [],
'streetNumber' => isset($comp['house_number']) ? $comp['house_number'] : null,
'streetName' => $this->guessStreetName($comp),
'subLocality' => $this->guessSubLocality($comp),
'locality' => $this->guessLocality($comp),
'postalCode' => isset($comp['postcode']) ? $comp['postcode'] : null,
'adminLevels' => $adminLevels,
'country' => isset($comp['country']) ? $comp['country'] : null,
'countryCode' => isset($comp['country_code']) ? strtoupper($comp['country_code']) : null,
'timezone' => isset($location['annotations']['timezone']['name']) ? $location['annotations']['timezone']['name'] : null,
));
}
return $this->returnResults($results);
}
/**
* @param array $components
*
* @return null|string
*/
protected function guessLocality(array $components)
{
$localityKeys = array('city', 'town' , 'village', 'hamlet');
return $this->guessBestComponent($components, $localityKeys);
}
/**
* @param array $components
*
* @return null|string
*/
protected function guessStreetName(array $components)
{
$streetNameKeys = array('road', 'street', 'street_name', 'residential');
return $this->guessBestComponent($components, $streetNameKeys);
}
/**
* @param array $components
*
* @return null|string
*/
protected function guessSubLocality(array $components)
{
$subLocalityKeys = array('suburb', 'neighbourhood', 'city_district');
return $this->guessBestComponent($components, $subLocalityKeys);
}
/**
* @param array $components
* @param array $keys
*
* @return null|string
*/
protected function guessBestComponent(array $components, array $keys)
{
foreach ($keys as $key) {
if (isset($components[$key]) && !empty($components[$key])) {
return $components[$key];
}
}
return null;
}
}