[RFC] Make Provider extends Geocoder

src/Geocoder/Provider/AbstractProvider.php

@@ -10,6 +10,7 @@
 
 namespace Geocoder\Provider;
 
+use Geocoder\Model\AddressFactory;
 use Geocoder\ProviderBasedGeocoder;
 use Ivory\HttpAdapter\HttpAdapterInterface;
 
@@ -33,6 +34,11 @@ abstract class AbstractProvider
      */
     protected $maxResults = ProviderBasedGeocoder::MAX_RESULTS;
 
+    /**
+     * @var AddressFactory
+     */
+    protected $factory;
+
     /**
      * @param HttpAdapterInterface $adapter An HTTP adapter.
      * @param string               $locale  A locale (optional).
@@ -41,6 +47,7 @@ public function __construct(HttpAdapterInterface $adapter, $locale = null)
     {
         $this->setAdapter($adapter);
         $this->setLocale($locale);
+        $this->factory  = new AddressFactory();
     }
 
     /**
@@ -163,4 +170,14 @@ protected function fixEncoding(array $results)
             return is_string($value) ? utf8_encode($value) : $value;
         }, $results);
     }
+
+    /**
+     * @param array $data An array of data.
+     *
+     * @return \Geocoder\Model\Address[]
+     */
+    protected function returnResult(array $data = [])
+    {
+        return $this->factory->createFromArray($data);
+    }
 }

src/Geocoder/Provider/GoogleMaps.php

@@ -10,10 +10,11 @@
 
 namespace Geocoder\Provider;
 
+use Geocoder\Exception\InvalidCredentials;
 use Geocoder\Exception\NoResult;
 use Geocoder\Exception\QuotaExceeded;
 use Geocoder\Exception\UnsupportedOperation;
-use Geocoder\Exception\InvalidCredentials;
+use Geocoder\Model\AddressFactory;
 use Ivory\HttpAdapter\HttpAdapterInterface;
 
 /**
@@ -62,10 +63,17 @@ public function __construct(HttpAdapterInterface $adapter, $locale = null, $regi
         $this->apiKey = $apiKey;
     }
 
+    public function setRegion($region)
+    {
+        $this->region = $region;
+
+        return $this;
+    }
+
     /**
      * {@inheritDoc}
      */
-    public function getGeocodedData($address)
+    public function geocode($address)
     {
         // Google API returns invalid data if IP address given
         // This API doesn't handle IPs
@@ -84,9 +92,9 @@ public function getGeocodedData($address)
     /**
      * {@inheritDoc}
      */
-    public function getReversedData(array $coordinates)
+    public function reverse($latitude, $longitude)
     {
-        return $this->getGeocodedData(sprintf('%F,%F', $coordinates[0], $coordinates[1]));
+        return $this->getGeocodedData(sprintf('%F,%F', $latitude, $longitude));
     }
 
     /**
@@ -197,7 +205,7 @@ private function executeQuery($query)
             $results[] = array_merge($this->getDefaults(), $resultset);
         }
 
-        return $results;
+        return $this->returnResult($results);
     }
 
     /**

src/Geocoder/Provider/Provider.php

@@ -10,41 +10,16 @@
 
 namespace Geocoder\Provider;
 
-use Geocoder\Exception\NoResult;
 use Geocoder\Exception\InvalidCredentials;
+use Geocoder\Exception\NoResult;
 use Geocoder\Exception\UnsupportedOperation;
+use Geocoder\Geocoder;
 
 /**
  * @author William Durand <william.durand1@gmail.com>
  */
-interface Provider
+interface Provider extends Geocoder
 {
-    /**
-     * Returns an associative array with data treated by the provider.
-     *
-     * @param string $address An address (IP or street).
-     *
-     * @throws NoResult             If the address could not be resolved
-     * @throws InvalidCredentials   If the credentials are invalid
-     * @throws UnsupportedOperation If IPv4, IPv6 or street is not supported
-     *
-     * @return array
-     */
-    public function getGeocodedData($address);
-
-    /**
-     * Returns an associative array with data treated by the provider.
-     *
-     * @param array $coordinates Coordinates (latitude, longitude).
-     *
-     * @throws NoResult             If the coordinates could not be resolved
-     * @throws InvalidCredentials   If the credentials are invalid
-     * @throws UnsupportedOperation If reverse geocoding is not supported
-     *
-     * @return array
-     */
-    public function getReversedData(array $coordinates);
-
     /**
      * Returns the provider's name.
      *

src/Geocoder/ProviderBasedGeocoder.php

@@ -12,7 +12,6 @@
 
 use Geocoder\Exception\ProviderNotRegistered;
 use Geocoder\Provider\Provider;
-use Geocoder\Model\AddressFactory;
 
 /**
  * @author William Durand <william.durand1@gmail.com>
@@ -34,11 +33,6 @@ class ProviderBasedGeocoder implements Geocoder
      */
     private $provider;
 
-    /**
-     * @var AddressFactory
-     */
-    private $factory;
-
     /**
      * @var integer
      */
@@ -51,7 +45,6 @@ class ProviderBasedGeocoder implements Geocoder
     public function __construct(Provider $provider = null, $maxResults = self::MAX_RESULTS)
     {
         $this->provider = $provider;
-        $this->factory  = new AddressFactory();
 
         $this->limit($maxResults);
     }
@@ -61,15 +54,16 @@ public function __construct(Provider $provider = null, $maxResults = self::MAX_R
      */
     public function geocode($value)
     {
+        $value = trim($value);
+
         if (empty($value)) {
             // let's save a request
             return [];
         }
 
         $provider = $this->getProvider()->setMaxResults($this->getMaxResults());
-        $data     = $provider->getGeocodedData(trim($value));
 
-        return $this->returnResult($data);
+        return $provider->geocode($value);
     }
 
     /**
@@ -83,9 +77,8 @@ public function reverse($latitude, $longitude)
         }
 
         $provider = $this->getProvider()->setMaxResults($this->getMaxResults());
-        $data     = $provider->getReversedData([ $latitude, $longitude ]);
 
-        return $this->returnResult($data);
+        return $provider->reverse($latitude, $longitude);
     }
 
     /**
@@ -185,14 +178,4 @@ protected function getProvider()
 
         return $this->provider;
     }
-
-    /**
-     * @param array $data An array of data.
-     *
-     * @return \Geocoder\Model\Address[]
-     */
-    protected function returnResult(array $data = [])
-    {
-        return $this->factory->createFromArray($data);
-    }
 }