Added PHP7 type hints (#639)

* Added return type hints

* Added changelog

Author: Nyholm

Collection.php

@@ -25,12 +25,12 @@ interface Collection extends \IteratorAggregate, \Countable
      *
      * @throws CollectionIsEmpty
      */
-    public function first();
+    public function first(): Location;
 
     /**
      * @return bool
      */
-    public function isEmpty();
+    public function isEmpty(): bool;
 
     /**
      * @return Location[]
@@ -40,14 +40,14 @@ public function slice($offset, $length = null);
     /**
      * @return bool
      */
-    public function has($index);
+    public function has($index): bool;
 
     /**
      * @return Location
      *
      * @throws \OutOfBoundsException
      */
-    public function get($index);
+    public function get($index): Location;
 
     /**
      * @return Location[]

Geocoder.php

@@ -37,7 +37,7 @@ interface Geocoder extends Provider
      *
      * @throws \Geocoder\Exception\Exception
      */
-    public function geocode($value);
+    public function geocode($value): Collection;
 
     /**
      * Reverses geocode given latitude and longitude values.
@@ -49,5 +49,5 @@ public function geocode($value);
      *
      * @throws \Geocoder\Exception\Exception
      */
-    public function reverse($latitude, $longitude);
+    public function reverse($latitude, $longitude): Collection;
 }

GeocoderTrait.php

@@ -27,15 +27,15 @@ abstract public function reverseQuery(ReverseQuery $query);
     /**
      * {@inheritdoc}
      */
-    public function geocode($value)
+    public function geocode($value): Collection
     {
         return $this->geocodeQuery(GeocodeQuery::create($value));
     }
 
     /**
      * {@inheritdoc}
      */
-    public function reverse($latitude, $longitude)
+    public function reverse($latitude, $longitude): Collection
     {
         return $this->reverseQuery(ReverseQuery::fromCoordinates($latitude, $longitude));
     }

Location.php

@@ -80,7 +80,7 @@ public function getSubLocality();
      *
      * @return AdminLevelCollection
      */
-    public function getAdminLevels();
+    public function getAdminLevels(): AdminLevelCollection;
 
     /**
      * Returns the country value object.
@@ -103,5 +103,5 @@ public function getTimezone();
      *
      * @return array
      */
-    public function toArray();
+    public function toArray(): array;
 }

Model/Address.php

@@ -82,14 +82,14 @@ class Address implements Location
     public function __construct(
         Coordinates $coordinates = null,
         Bounds $bounds = null,
-        $streetNumber = null,
-        $streetName = null,
-        $postalCode = null,
-        $locality = null,
-        $subLocality = null,
+        string $streetNumber = null,
+        string $streetName = null,
+        string $postalCode = null,
+        string $locality = null,
+        string $subLocality = null,
         AdminLevelCollection $adminLevels = null,
         Country $country = null,
-        $timezone = null
+        string $timezone = null
     ) {
         $this->coordinates = $coordinates;
         $this->bounds = $bounds;
@@ -162,7 +162,7 @@ public function getSubLocality()
     /**
      * {@inheritdoc}
      */
-    public function getAdminLevels()
+    public function getAdminLevels(): AdminLevelCollection
     {
         return $this->adminLevels;
     }
@@ -282,7 +282,7 @@ private static function createBounds($south, $west, $north, $east)
     /**
      * {@inheritdoc}
      */
-    public function toArray()
+    public function toArray(): array
     {
         $adminLevels = [];
         foreach ($this->adminLevels as $adminLevel) {

Model/AddressCollection.php

@@ -48,7 +48,7 @@ public function count()
     /**
      * {@inheritdoc}
      */
-    public function first()
+    public function first(): Location
     {
         if (empty($this->locations)) {
             throw new CollectionIsEmpty();
@@ -60,7 +60,7 @@ public function first()
     /**
      * {@inheritdoc}
      */
-    public function isEmpty()
+    public function isEmpty(): bool
     {
         return empty($this->locations);
     }
@@ -76,15 +76,15 @@ public function slice($offset, $length = null)
     /**
      * @return bool
      */
-    public function has($index)
+    public function has($index): bool
     {
         return isset($this->locations[$index]);
     }
 
     /**
      * {@inheritdoc}
      */
-    public function get($index)
+    public function get($index): Location
     {
         if (!isset($this->locations[$index])) {
             throw new \OutOfBoundsException(sprintf('The index "%s" does not exist in this collection.', $index));

Model/AdminLevel.php

@@ -26,14 +26,14 @@ final class AdminLevel
     private $name;
 
     /**
-     * @var string
+     * @var string|null
      */
     private $code;
 
     /**
-     * @param int    $level
-     * @param string $name
-     * @param string $code
+     * @param int         $level
+     * @param string      $name
+     * @param string|null $code
      */
     public function __construct($level, $name, $code)
     {

Model/AdminLevelCollection.php

@@ -85,7 +85,7 @@ public function slice($offset, $length = null)
     /**
      * @return bool
      */
-    public function has($level)
+    public function has($level): bool
     {
         return isset($this->adminLevels[$level]);
     }
@@ -96,7 +96,7 @@ public function has($level)
      * @throws \OutOfBoundsException
      * @throws InvalidArgument
      */
-    public function get($level)
+    public function get($level): AdminLevel
     {
         $this->checkLevel($level);
 

Model/Bounds.php

@@ -66,7 +66,7 @@ public function __construct($south, $west, $north, $east)
      *
      * @return float
      */
-    public function getSouth()
+    public function getSouth(): float
     {
         return $this->south;
     }
@@ -76,7 +76,7 @@ public function getSouth()
      *
      * @return float
      */
-    public function getWest()
+    public function getWest(): float
     {
         return $this->west;
     }
@@ -86,7 +86,7 @@ public function getWest()
      *
      * @return float
      */
-    public function getNorth()
+    public function getNorth(): float
     {
         return $this->north;
     }
@@ -96,7 +96,7 @@ public function getNorth()
      *
      * @return float
      */
-    public function getEast()
+    public function getEast(): float
     {
         return $this->east;
     }
@@ -106,7 +106,7 @@ public function getEast()
      *
      * @return array
      */
-    public function toArray()
+    public function toArray(): array
     {
         return [
             'south' => $this->getSouth(),

Model/Coordinates.php

@@ -48,7 +48,7 @@ public function __construct($latitude, $longitude)
      *
      * @return float
      */
-    public function getLatitude()
+    public function getLatitude(): float
     {
         return $this->latitude;
     }
@@ -58,7 +58,7 @@ public function getLatitude()
      *
      * @return float
      */
-    public function getLongitude()
+    public function getLongitude(): float
     {
         return $this->longitude;
     }