forked from geocoder-php/Geocoder
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathOpenCageProvider.php
More file actions
157 lines (126 loc) · 4.98 KB
/
Copy pathOpenCageProvider.php
File metadata and controls
157 lines (126 loc) · 4.98 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
<?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\InvalidCredentialsException;
use Geocoder\HttpAdapter\HttpAdapterInterface;
use Geocoder\Exception\NoResultException;
use Geocoder\Exception\UnsupportedException;
/**
* @author mtm <mtm@opencagedata.com>
*/
class OpenCageProvider extends AbstractProvider implements ProviderInterface
{
/**
* @var string
*/
const GEOCODE_ENDPOINT_URL = '%s://api.opencagedata.com/geocode/v1/json?key=%s&query=%s&limit=%d&pretty=1';
/**
* @var string
*/
private $scheme = 'http';
/**
* @var string
*/
private $apiKey = null;
/**
* @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, $locale);
$this->apiKey = $apiKey;
$this->scheme = $useSsl ? 'https' : $this->scheme;
}
/**
* {@inheritDoc}
*/
public function getGeocodedData($address)
{
// This API doesn't handle IPs
if (filter_var($address, FILTER_VALIDATE_IP)) {
throw new UnsupportedException('The OpenCageProvider does not support IP addresses.');
}
if (null === $this->apiKey) {
throw new InvalidCredentialsException('No API Key provided.');
}
$query = sprintf(self::GEOCODE_ENDPOINT_URL, $this->scheme, $this->apiKey, urlencode($address), $this->getMaxResults() );
return $this->executeQuery($query);
}
/**
* {@inheritDoc}
*/
public function getReversedData(array $coordinates)
{
// latitude, longitude
$address = sprintf("%f, %f", $coordinates[0], $coordinates[1]);
return $this->getGeocodedData($address);
}
/**
* {@inheritDoc}
*/
public function getName()
{
return 'opencage';
}
/**
* @param string $query
*
* @return array
*/
protected function executeQuery($query)
{
if (null !== $this->getLocale()) {
$query = sprintf('%s&language=%s', $query, $this->getLocale());
}
$content = $this->getAdapter()->getContent($query);
if (null === $content) {
throw new NoResultException(sprintf('Could not execute query: %s', $query));
}
$json = json_decode($content, true);
if (!isset($json['total_results']) || $json['total_results'] == 0 ) {
throw new NoResultException(sprintf('Could not find results for given query: %s', $query));
}
$locations = $json['results'];
if (empty($locations)) {
throw new NoResultException(sprintf('Could not find results for given query: %s', $query));
}
$results = array();
foreach ($locations as $location) {
$bounds = null;
if (isset($location['bounds'])) {
$bounds = array(
'south' => $location['bounds']['southwest']['lat'],
'west' => $location['bounds']['southwest']['lng'],
'north' => $location['bounds']['northeast']['lat'],
'east' => $location['bounds']['northeast']['lng'],
);
}
$comp = $location['components'];
$results[] = array_merge($this->getDefaults(), array(
'latitude' => $location['geometry']['lat'],
'longitude' => $location['geometry']['lng'],
'bounds' => $bounds ?: null,
'streetNumber' => isset($comp['house_number']) ? $comp['house_number'] : null,
'streetName' => isset($comp['road'] ) ? $comp['road'] : null,
'cityDistrict' => isset($comp['suburb'] ) ? $comp['suburb'] : null,
'city' => isset($comp['city'] ) ? $comp['city'] : null,
'zipcode' => isset($comp['postcode'] ) ? $comp['postcode'] : null,
'county' => isset($comp['county'] ) ? $comp['county'] : null,
'region' => isset($comp['state'] ) ? $comp['state'] : null,
'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 $results;
}
}