1 | <?php |
||
26 | class Batch implements BatchInterface |
||
27 | { |
||
28 | /** |
||
29 | * The Geocoder instance to use. |
||
30 | * |
||
31 | * @var Geocoder |
||
32 | */ |
||
33 | protected $geocoder; |
||
34 | |||
35 | /** |
||
36 | * An array of closures. |
||
37 | * |
||
38 | * @var array |
||
39 | */ |
||
40 | protected $tasks; |
||
41 | |||
42 | /** |
||
43 | * The cache instance to use. |
||
44 | * |
||
45 | * @var CacheInterface |
||
46 | */ |
||
47 | protected $cache; |
||
48 | |||
49 | /** |
||
50 | * Set the Geocoder instance to use. |
||
51 | * |
||
52 | * @param Geocoder $geocoder The Geocoder instance to use. |
||
53 | */ |
||
54 | 61 | public function __construct(Geocoder $geocoder) |
|
58 | |||
59 | /** |
||
60 | * Check against the cache instance if any. |
||
61 | * |
||
62 | * @param string $providerName The name of the provider. |
||
63 | * @param string $query The query string. |
||
64 | * |
||
65 | * @return boolean|BatchGeocoded The BatchGeocoded object from the query or the cache instance. |
||
66 | */ |
||
67 | 34 | public function isCached($providerName, $query) |
|
71 | |||
72 | /** |
||
73 | * Cache the BatchGeocoded object. |
||
74 | * |
||
75 | * @param BatchGeocoded $geocoded The BatchGeocoded object to cache. |
||
76 | * |
||
77 | * @return BatchGeocoded The BatchGeocoded object. |
||
78 | */ |
||
79 | 9 | public function cache(BatchGeocoded $geocoded) |
|
80 | { |
||
81 | 9 | if (isset($this->cache)) { |
|
82 | 1 | $this->cache->cache($geocoded); |
|
83 | } |
||
84 | |||
85 | 9 | return $geocoded; |
|
86 | } |
||
87 | |||
88 | /** |
||
89 | * {@inheritDoc} |
||
90 | */ |
||
91 | 28 | public function geocode($values) |
|
92 | { |
||
93 | 28 | $geocoder = $this->geocoder; |
|
94 | 28 | $cache = $this; |
|
95 | |||
96 | 28 | foreach ($geocoder->getProviders() as $provider) { |
|
|
|||
97 | 28 | if (is_array($values) && count($values) > 0) { |
|
98 | 9 | foreach ($values as $value) { |
|
99 | $this->tasks[] = function () use ($geocoder, $provider, $value, $cache) { |
||
100 | 8 | $deferred = new Deferred; |
|
101 | |||
102 | try { |
||
103 | 8 | if ($cached = $cache->isCached($provider->getName(), $value)) { |
|
104 | 4 | $deferred->resolve($cached); |
|
105 | } else { |
||
106 | 4 | $batchResult = new BatchResult($provider->getName(), $value); |
|
107 | 4 | $address = $geocoder->using($provider->getName())->geocode($value)->first(); |
|
108 | 6 | $deferred->resolve($cache->cache($batchResult->createFromAddress($address))); |
|
109 | } |
||
110 | 2 | } catch (\Exception $e) { |
|
111 | 2 | $batchGeocoded = new BatchResult($provider->getName(), $value, $e->getMessage()); |
|
112 | 2 | $deferred->reject($batchGeocoded->newInstance()); |
|
113 | } |
||
114 | |||
115 | 8 | return $deferred->promise(); |
|
116 | 9 | }; |
|
117 | } |
||
118 | 19 | } elseif (is_string($values) && '' !== trim($values)) { |
|
119 | $this->tasks[] = function () use ($geocoder, $provider, $values, $cache) { |
||
120 | 8 | $deferred = new Deferred; |
|
121 | |||
122 | try { |
||
123 | 8 | if ($cached = $cache->isCached($provider->getName(), $values)) { |
|
124 | 4 | $deferred->resolve($cached); |
|
125 | } else { |
||
126 | 4 | $batchResult = new BatchResult($provider->getName(), $values); |
|
127 | 4 | $address = $geocoder->using($provider->getName())->geocode($values)->first(); |
|
128 | 6 | $deferred->resolve($cache->cache($batchResult->createFromAddress($address))); |
|
129 | } |
||
130 | 2 | } catch (\Exception $e) { |
|
131 | 2 | $batchGeocoded = new BatchResult($provider->getName(), $values, $e->getMessage()); |
|
132 | 2 | $deferred->reject($batchGeocoded->newInstance()); |
|
133 | } |
||
134 | |||
135 | 8 | return $deferred->promise(); |
|
136 | 12 | }; |
|
137 | } else { |
||
138 | 7 | throw new InvalidArgumentException( |
|
139 | 28 | 'The argument should be a string or an array of strings to geocode.' |
|
140 | ); |
||
141 | } |
||
142 | } |
||
143 | |||
144 | 21 | return $this; |
|
145 | } |
||
146 | |||
147 | /** |
||
148 | * {@inheritDoc} |
||
149 | */ |
||
150 | 26 | public function reverse($coordinates) |
|
151 | { |
||
152 | 26 | $geocoder = $this->geocoder; |
|
153 | 26 | $cache = $this; |
|
154 | |||
155 | 26 | foreach ($geocoder->getProviders() as $provider) { |
|
156 | 26 | if (is_array($coordinates) && count($coordinates) > 0) { |
|
157 | 9 | foreach ($coordinates as $coordinate) { |
|
158 | $this->tasks[] = function () use ($geocoder, $provider, $coordinate, $cache) { |
||
159 | 8 | $deferred = new Deferred(); |
|
160 | |||
161 | 8 | $valueCoordinates = sprintf('%s, %s', $coordinate->getLatitude(), $coordinate->getLongitude()); |
|
162 | try { |
||
163 | 8 | if ($cached = $cache->isCached($provider->getName(), $valueCoordinates)) { |
|
164 | 4 | $deferred->resolve($cached); |
|
165 | } else { |
||
166 | 4 | $batchResult = new BatchResult($provider->getName(), $valueCoordinates); |
|
167 | 4 | $address = $geocoder->using($provider->getName())->reverse( |
|
168 | 4 | $coordinate->getLatitude(), |
|
169 | 4 | $coordinate->getLongitude() |
|
170 | 2 | )->first(); |
|
171 | |||
172 | 6 | $deferred->resolve($cache->cache($batchResult->createFromAddress($address))); |
|
173 | } |
||
174 | 2 | } catch (\Exception $e) { |
|
175 | 2 | $batchGeocoded = new BatchResult($provider->getName(), $valueCoordinates, $e->getMessage()); |
|
176 | 2 | $deferred->reject($batchGeocoded->newInstance()); |
|
177 | } |
||
178 | |||
179 | 8 | return $deferred->promise(); |
|
180 | 9 | }; |
|
181 | } |
||
182 | } elseif ($coordinates instanceOf CoordinateInterface) { |
||
183 | $this->tasks[] = function () use ($geocoder, $provider, $coordinates, $cache) { |
||
184 | 8 | $deferred = new Deferred(); |
|
185 | |||
186 | 8 | $valueCoordinates = sprintf('%s, %s', $coordinates->getLatitude(), $coordinates->getLongitude()); |
|
187 | try { |
||
188 | 8 | if ($cached = $cache->isCached($provider->getName(), $valueCoordinates)) { |
|
189 | 4 | $deferred->resolve($cached); |
|
190 | } else { |
||
191 | 4 | $batchResult = new BatchResult($provider->getName(), $valueCoordinates); |
|
192 | 4 | $address = $geocoder->using($provider->getName())->reverse( |
|
193 | 4 | $coordinates->getLatitude(), |
|
194 | 4 | $coordinates->getLongitude() |
|
195 | 2 | )->first(); |
|
196 | 6 | $deferred->resolve($cache->cache($batchResult->createFromAddress($address))); |
|
197 | } |
||
198 | 2 | } catch (\Exception $e) { |
|
199 | 2 | $batchGeocoded = new BatchResult($provider->getName(), $valueCoordinates, $e->getMessage()); |
|
200 | 2 | $deferred->reject($batchGeocoded->newInstance()); |
|
201 | } |
||
202 | |||
203 | 8 | return $deferred->promise(); |
|
204 | 10 | }; |
|
205 | } else { |
||
206 | 7 | throw new InvalidArgumentException( |
|
207 | 26 | 'The argument should be a Coordinate instance or an array of Coordinate instances to reverse.' |
|
208 | ); |
||
209 | } |
||
210 | } |
||
211 | |||
212 | 19 | return $this; |
|
213 | } |
||
214 | |||
215 | /** |
||
216 | * {@inheritDoc} |
||
217 | * |
||
218 | * $this cannot be used in anonymous function in PHP 5.3.x |
||
219 | * @see http://php.net/manual/en/functions.anonymous.php |
||
220 | */ |
||
221 | 17 | public function serie() |
|
222 | { |
||
223 | 17 | $computedInSerie = array(); |
|
224 | |||
225 | 17 | foreach ($this->tasks as $task) { |
|
226 | $task()->then(function($result) use (&$computedInSerie) { |
||
227 | 13 | $computedInSerie[] = $result; |
|
228 | }, function ($emptyResult) use (&$computedInSerie) { |
||
229 | 4 | $computedInSerie[] = $emptyResult; |
|
230 | 17 | }); |
|
231 | } |
||
232 | |||
233 | 16 | return $computedInSerie; |
|
234 | } |
||
235 | |||
236 | /** |
||
237 | * {@inheritDoc} |
||
238 | * |
||
239 | * $this cannot be used in anonymous function in PHP 5.3.x |
||
240 | * @see http://php.net/manual/en/functions.anonymous.php |
||
241 | */ |
||
242 | 17 | public function parallel() |
|
243 | { |
||
244 | 17 | $loop = EventLoopFactory::create(); |
|
245 | 17 | $computedInParallel = array(); |
|
246 | |||
247 | 17 | foreach ($this->tasks as $task) { |
|
248 | $loop->nextTick(function () use ($task, &$computedInParallel) { |
||
249 | $task()->then(function($result) use (&$computedInParallel) { |
||
250 | 12 | $computedInParallel[] = $result; |
|
251 | 16 | }, function ($emptyResult) use (&$computedInParallel) { |
|
252 | 4 | $computedInParallel[] = $emptyResult; |
|
253 | 16 | }); |
|
254 | 17 | }); |
|
255 | } |
||
256 | |||
257 | 17 | $loop->run(); |
|
258 | |||
259 | 16 | return $computedInParallel; |
|
260 | } |
||
261 | |||
262 | /** |
||
263 | * {@inheritDoc} |
||
264 | */ |
||
265 | 19 | public function setCache(CacheInterface $cache) |
|
271 | } |
||
272 |
Let’s take a look at an example:
In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.
Available Fixes
Change the type-hint for the parameter:
Add an additional type-check:
Add the method to the interface: