Added type hints (#645)

* Added type hints

* Updated implementing classes

* Fix

Author: Nyholm

GeocoderTrait.php

@@ -22,9 +22,9 @@
  */
 trait GeocoderTrait
 {
-    abstract public function geocodeQuery(GeocodeQuery $query);
+    abstract public function geocodeQuery(GeocodeQuery $query): Collection;
 
-    abstract public function reverseQuery(ReverseQuery $query);
+    abstract public function reverseQuery(ReverseQuery $query): Collection;
 
     /**
      * {@inheritdoc}

Provider/Provider.php

@@ -12,7 +12,7 @@
 
 namespace Geocoder\Provider;
 
-use Geocoder\Model\AddressCollection;
+use Geocoder\Collection;
 use Geocoder\Query\GeocodeQuery;
 use Geocoder\Query\ReverseQuery;
 
@@ -27,21 +27,25 @@ interface Provider
     /**
      * @param GeocodeQuery $query
      *
-     * @return AddressCollection
+     * @return Collection
+     *
+     * @throws \Geocoder\Exception\Exception
      */
-    public function geocodeQuery(GeocodeQuery $query);
+    public function geocodeQuery(GeocodeQuery $query): Collection;
 
     /**
      * @param ReverseQuery $query
      *
-     * @return AddressCollection
+     * @return Collection
+     *
+     * @throws \Geocoder\Exception\Exception
      */
-    public function reverseQuery(ReverseQuery $query);
+    public function reverseQuery(ReverseQuery $query): Collection;
 
     /**
      * Returns the provider's name.
      *
      * @return string
      */
-    public function getName();
+    public function getName(): string;
 }

ProviderAggregator.php

@@ -49,23 +49,23 @@ public function __construct($limit = Geocoder::DEFAULT_RESULT_LIMIT)
     /**
      * {@inheritdoc}
      */
-    public function geocodeQuery(GeocodeQuery $query)
+    public function geocodeQuery(GeocodeQuery $query): Collection
     {
         return $this->getProvider()->geocodeQuery($query);
     }
 
     /**
      * {@inheritdoc}
      */
-    public function reverseQuery(ReverseQuery $query)
+    public function reverseQuery(ReverseQuery $query): Collection
     {
         return $this->getProvider()->reverseQuery($query);
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getName()
+    public function getName(): string
     {
         return 'ProviderAggregator';
     }

StatefulGeocoder.php

@@ -91,7 +91,7 @@ public function reverse($latitude, $longitude): Collection
     /**
      * {@inheritdoc}
      */
-    public function geocodeQuery(GeocodeQuery $query)
+    public function geocodeQuery(GeocodeQuery $query): Collection
     {
         $data = $query->getLocale();
         if (empty($data)) {
@@ -109,7 +109,7 @@ public function geocodeQuery(GeocodeQuery $query)
     /**
      * {@inheritdoc}
      */
-    public function reverseQuery(ReverseQuery $query)
+    public function reverseQuery(ReverseQuery $query): Collection
     {
         $data = $query->getLocale();
         if (empty($data)) {
@@ -158,7 +158,7 @@ public function setLimit($limit)
     /**
      * {@inheritdoc}
      */
-    public function getName()
+    public function getName(): string
     {
         return 'stateful_geocoder';
     }

Tests/ProviderAggregatorTest.php

@@ -12,6 +12,7 @@
 
 namespace Geocoder\Tests;
 
+use Geocoder\Collection;
 use Geocoder\Geocoder;
 use Geocoder\Query\GeocodeQuery;
 use Geocoder\Query\ReverseQuery;
@@ -146,17 +147,17 @@ public function __construct($name)
         $this->name = $name;
     }
 
-    public function geocodeQuery(GeocodeQuery $query)
+    public function geocodeQuery(GeocodeQuery $query): Collection
     {
         return $this->returnResult([]);
     }
 
-    public function reverseQuery(ReverseQuery $query)
+    public function reverseQuery(ReverseQuery $query): Collection
     {
         return $this->returnResult([]);
     }
 
-    public function getName()
+    public function getName(): string
     {
         return $this->name;
     }

TimedGeocoder.php

@@ -87,7 +87,7 @@ public function __call($method, $args)
         return call_user_func_array([$this->delegate, $method], $args);
     }
 
-    public function getName()
+    public function getName(): string
     {
         return 'TimedGeocoder';
     }