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
|
<?php
declare(strict_types=1);
/*
* 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;
use Geocoder\Exception\ProviderNotRegistered;
use Geocoder\Model\Coordinates;
use Geocoder\Query\GeocodeQuery;
use Geocoder\Query\ReverseQuery;
use Geocoder\Provider\Provider;
/**
* @author William Durand <william.durand1@gmail.com>
*/
class ProviderAggregator implements Geocoder
{
/**
* @var Provider[]
*/
private $providers = [];
/**
* @var Provider
*/
private $provider;
/**
* @var int
*/
private $limit;
/**
* A callable that decided what provider to use.
*
* @var callable
*/
private $decider;
/**
* @param callable|null $decider
* @param int $limit
*/
public function __construct(callable $decider = null, int $limit = Geocoder::DEFAULT_RESULT_LIMIT)
{
$this->limit = $limit;
$this->decider = $decider ?? __CLASS__.'::getProvider';
}
/**
* {@inheritdoc}
*/
public function geocodeQuery(GeocodeQuery $query): Collection
{
if (null === $query->getLimit()) {
$query = $query->withLimit($this->limit);
}
return call_user_func($this->decider, $query, $this->providers, $this->provider)->geocodeQuery($query);
}
/**
* {@inheritdoc}
*/
public function reverseQuery(ReverseQuery $query): Collection
{
if (null === $query->getLimit()) {
$query = $query->withLimit($this->limit);
}
return call_user_func($this->decider, $query, $this->providers, $this->provider)->reverseQuery($query);
}
/**
* {@inheritdoc}
*/
public function getName(): string
{
return 'provider_aggregator';
}
/**
* {@inheritdoc}
*/
public function geocode(string $value): Collection
{
return $this->geocodeQuery(GeocodeQuery::create($value)
->withLimit($this->limit));
}
/**
* {@inheritdoc}
*/
public function reverse(float $latitude, float $longitude): Collection
{
return $this->reverseQuery(ReverseQuery::create(new Coordinates($latitude, $longitude))
->withLimit($this->limit));
}
/**
* Registers a new provider to the aggregator.
*
* @param Provider $provider
*
* @return ProviderAggregator
*/
public function registerProvider(Provider $provider): self
{
$this->providers[$provider->getName()] = $provider;
return $this;
}
/**
* Registers a set of providers.
*
* @param Provider[] $providers
*
* @return ProviderAggregator
*/
public function registerProviders(array $providers = []): self
{
foreach ($providers as $provider) {
$this->registerProvider($provider);
}
return $this;
}
/**
* Sets the default provider to use.
*
* @param string $name
*
* @return ProviderAggregator
*/
public function using(string $name): self
{
if (!isset($this->providers[$name])) {
throw ProviderNotRegistered::create($name ?? '', $this->providers);
}
$this->provider = $this->providers[$name];
return $this;
}
/**
* Returns all registered providers indexed by their name.
*
* @return Provider[]
*/
public function getProviders(): array
{
return $this->providers;
}
/**
* Get a provider to use for this query.
*
* @param GeocodeQuery|ReverseQuery $query
* @param Provider[] $providers
* @param Provider $currentProvider
*
* @return Provider
*
* @throws ProviderNotRegistered
*/
private static function getProvider($query, array $providers, Provider $currentProvider = null): Provider
{
if (null !== $currentProvider) {
return $currentProvider;
}
if (0 === count($providers)) {
throw ProviderNotRegistered::noProviderRegistered();
}
// Take first
$key = key($providers);
return $providers[$key];
}
}
|
