forked from geocoder-php/Geocoder
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathAbstractProvider.php
More file actions
166 lines (147 loc) · 3.48 KB
/
Copy pathAbstractProvider.php
File metadata and controls
166 lines (147 loc) · 3.48 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
<?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\Geocoder;
use Geocoder\HttpAdapter\HttpAdapterInterface;
/**
* @author William Durand <william.durand1@gmail.com>
*/
abstract class AbstractProvider
{
/**
* @var HttpAdapterInterface
*/
protected $adapter = null;
/**
* @var string
*/
protected $locale = null;
/**
* @var integer
*/
protected $maxResults = Geocoder::MAX_RESULTS;
/**
* @param HttpAdapterInterface $adapter An HTTP adapter.
* @param string $locale A locale (optional).
*/
public function __construct(HttpAdapterInterface $adapter, $locale = null)
{
$this->setAdapter($adapter);
$this->setLocale($locale);
}
/**
* Returns the HTTP adapter.
*
* @return HttpAdapterInterface
*/
public function getAdapter()
{
return $this->adapter;
}
/**
* Sets the HTTP adapter to be used for further requests.
*
* @param HttpAdapterInterface $adapter
*
* @return AbstractProvider
*/
public function setAdapter($adapter)
{
$this->adapter = $adapter;
return $this;
}
/**
* Returns the configured locale or null.
*
* @return string
*/
public function getLocale()
{
return $this->locale;
}
/**
* Sets the locale to be used.
*
* @param string|null $locale If no locale is set, the provider or service will fallback.
*
* @return AbstractProvider
*/
public function setLocale($locale = null)
{
$this->locale = $locale;
return $this;
}
/**
* {@inheritDoc}
*/
public function setMaxResults($maxResults)
{
$this->maxResults = $maxResults;
return $this;
}
/**
* Returns the maximum of wished results.
*
* @return integer
*/
public function getMaxResults()
{
return $this->maxResults;
}
/**
* Returns the default results.
*
* @return array
*/
protected function getDefaults()
{
return array(
'latitude' => null,
'longitude' => null,
'bounds' => null,
'streetNumber' => null,
'streetName' => null,
'city' => null,
'zipcode' => null,
'cityDistrict' => null,
'county' => null,
'countyCode' => null,
'region' => null,
'regionCode' => null,
'country' => null,
'countryCode' => null,
'timezone' => null,
);
}
/**
* Returns the results for the 'localhost' special case.
*
* @return array
*/
protected function getLocalhostDefaults()
{
return array(
'city' => 'localhost',
'region' => 'localhost',
'county' => 'localhost',
'country' => 'localhost',
);
}
/**
* @param array $results
*
* @return array
*/
protected function fixEncoding(array $results)
{
return array_map(function ($value) {
return is_string($value) ? utf8_encode($value) : $value;
}, $results);
}
}