Php7 type hints (#708)

* Added some PSR-7 typehints

* Added some PSR-7 typehints

* Adding PHP7 stuff

* Adding more typehints

* Use Throwable instead of Exception

* Applied changes from StyleCI

Author: Nyholm

Collection.php

@@ -13,6 +13,7 @@
 namespace Geocoder;
 
 use Geocoder\Exception\CollectionIsEmpty;
+use Geocoder\Exception\OutOfBoundsException;
 
 /**
  * This is the interface that is always return from a Geocoder.
@@ -37,22 +38,22 @@ public function isEmpty(): bool;
     /**
      * @return Location[]
      */
-    public function slice($offset, $length = null);
+    public function slice(int $offset, int $length = null);
 
     /**
      * @return bool
      */
-    public function has($index): bool;
+    public function has(int $index): bool;
 
     /**
      * @return Location
      *
-     * @throws \OutOfBoundsException
+     * @throws OutOfBoundsException
      */
-    public function get($index): Location;
+    public function get(int $index): Location;
 
     /**
      * @return Location[]
      */
-    public function all();
+    public function all(): array;
 }

Geocoder.php

@@ -51,5 +51,5 @@ public function geocode(string $value): Collection;
      *
      * @throws \Geocoder\Exception\Exception
      */
-    public function reverse($latitude, $longitude): Collection;
+    public function reverse(float $latitude, float $longitude): Collection;
 }

GeocoderTrait.php

@@ -37,7 +37,7 @@ public function geocode(string $value): Collection
     /**
      * {@inheritdoc}
      */
-    public function reverse($latitude, $longitude): Collection
+    public function reverse(float $latitude, float $longitude): Collection
     {
         return $this->reverseQuery(ReverseQuery::fromCoordinates($latitude, $longitude));
     }

Model/Address.php

@@ -235,9 +235,18 @@ public static function createFromArray(array $data)
 
         $adminLevels = [];
         foreach ($data['adminLevels'] as $adminLevel) {
+            if (empty($adminLevel['level'])) {
+                continue;
+            }
+
+            $name = $adminLevel['name'] ?? $adminLevel['code'] ?? null;
+            if (empty($name)) {
+                continue;
+            }
+
             $adminLevels[] = new AdminLevel(
-                $adminLevel['level'] ?? null,
-                $adminLevel['name'] ?? null,
+                $adminLevel['level'],
+                $name,
                 $adminLevel['code'] ?? null
             );
         }

Model/AddressBuilder.php

@@ -12,6 +12,7 @@
 
 namespace Geocoder\Model;
 
+use Geocoder\Exception\InvalidArgument;
 use Geocoder\Exception\LogicException;
 
 /**
@@ -101,7 +102,7 @@ public function __construct(string $providedBy)
      *
      * @return Address
      */
-    public function build(string $class = Address::class)
+    public function build(string $class = Address::class): Address
     {
         if (!is_a($class, Address::class, true)) {
             throw new LogicException('First parameter to LocationBuilder::build must be a class name extending Geocoder\Model\Address');
@@ -135,11 +136,11 @@ public function build(string $class = Address::class)
      *
      * @return AddressBuilder
      */
-    public function setBounds($south, $west, $north, $east)
+    public function setBounds($south, $west, $north, $east): self
     {
         try {
             $this->bounds = new Bounds($south, $west, $north, $east);
-        } catch (\InvalidArgumentException $e) {
+        } catch (InvalidArgument $e) {
             $this->bounds = null;
         }
 
@@ -152,25 +153,25 @@ public function setBounds($south, $west, $north, $east)
      *
      * @return AddressBuilder
      */
-    public function setCoordinates($latitude, $longitude)
+    public function setCoordinates($latitude, $longitude): self
     {
         try {
             $this->coordinates = new Coordinates($latitude, $longitude);
-        } catch (\InvalidArgumentException $e) {
+        } catch (InvalidArgument $e) {
             $this->coordinates = null;
         }
 
         return $this;
     }
 
     /**
-     * @param int    $level
-     * @param string $name
-     * @param string $code
+     * @param int         $level
+     * @param string      $name
+     * @param string|null $code
      *
      * @return AddressBuilder
      */
-    public function addAdminLevel($level, $name, $code)
+    public function addAdminLevel(int $level, string $name, string $code = null): self
     {
         $this->adminLevels[] = new AdminLevel($level, $name, $code);
 
@@ -182,7 +183,7 @@ public function addAdminLevel($level, $name, $code)
      *
      * @return AddressBuilder
      */
-    public function setStreetNumber($streetNumber)
+    public function setStreetNumber($streetNumber): self
     {
         $this->streetNumber = $streetNumber;
 
@@ -194,7 +195,7 @@ public function setStreetNumber($streetNumber)
      *
      * @return AddressBuilder
      */
-    public function setStreetName($streetName)
+    public function setStreetName($streetName): self
     {
         $this->streetName = $streetName;
 
@@ -206,7 +207,7 @@ public function setStreetName($streetName)
      *
      * @return AddressBuilder
      */
-    public function setLocality($locality)
+    public function setLocality($locality): self
     {
         $this->locality = $locality;
 
@@ -218,7 +219,7 @@ public function setLocality($locality)
      *
      * @return AddressBuilder
      */
-    public function setPostalCode($postalCode)
+    public function setPostalCode($postalCode): self
     {
         $this->postalCode = $postalCode;
 
@@ -230,7 +231,7 @@ public function setPostalCode($postalCode)
      *
      * @return AddressBuilder
      */
-    public function setSubLocality($subLocality)
+    public function setSubLocality($subLocality): self
     {
         $this->subLocality = $subLocality;
 
@@ -242,7 +243,7 @@ public function setSubLocality($subLocality)
      *
      * @return AddressBuilder
      */
-    public function setAdminLevels($adminLevels)
+    public function setAdminLevels($adminLevels): self
     {
         $this->adminLevels = $adminLevels;
 
@@ -254,7 +255,7 @@ public function setAdminLevels($adminLevels)
      *
      * @return AddressBuilder
      */
-    public function setCountry($country)
+    public function setCountry($country): self
     {
         $this->country = $country;
 
@@ -266,7 +267,7 @@ public function setCountry($country)
      *
      * @return AddressBuilder
      */
-    public function setCountryCode($countryCode)
+    public function setCountryCode($countryCode): self
     {
         $this->countryCode = $countryCode;
 
@@ -278,7 +279,7 @@ public function setCountryCode($countryCode)
      *
      * @return AddressBuilder
      */
-    public function setTimezone($timezone)
+    public function setTimezone($timezone): self
     {
         $this->timezone = $timezone;
 
@@ -289,9 +290,9 @@ public function setTimezone($timezone)
      * @param string $name
      * @param mixed  $value
      *
-     * @return $this
+     * @return AddressBuilder
      */
-    public function setValue(string $name, $value)
+    public function setValue(string $name, $value): self
     {
         $this->data[$name] = $value;
 
@@ -301,6 +302,8 @@ public function setValue(string $name, $value)
     /**
      * @param string     $name
      * @param mixed|null $default
+     *
+     * @return mixed
      */
     public function getValue(string $name, $default = null)
     {

Model/AddressCollection.php

@@ -71,23 +71,23 @@ public function isEmpty(): bool
     /**
      * @return Location[]
      */
-    public function slice($offset, $length = null)
+    public function slice(int $offset, int $length = null)
     {
         return array_slice($this->locations, $offset, $length);
     }
 
     /**
      * @return bool
      */
-    public function has($index): bool
+    public function has(int $index): bool
     {
         return isset($this->locations[$index]);
     }
 
     /**
      * {@inheritdoc}
      */
-    public function get($index): Location
+    public function get(int $index): Location
     {
         if (!isset($this->locations[$index])) {
             throw new OutOfBoundsException(sprintf('The index "%s" does not exist in this collection.', $index));
@@ -99,7 +99,7 @@ public function get($index): Location
     /**
      * {@inheritdoc}
      */
-    public function all()
+    public function all(): array
     {
         return $this->locations;
     }

Model/AdminLevel.php

@@ -37,7 +37,7 @@ final class AdminLevel
      * @param string      $name
      * @param string|null $code
      */
-    public function __construct($level, $name, $code)
+    public function __construct(int $level, string $name, string $code = null)
     {
         $this->level = $level;
         $this->name = $name;
@@ -49,7 +49,7 @@ public function __construct($level, $name, $code)
      *
      * @return int Level number [1,5]
      */
-    public function getLevel()
+    public function getLevel(): int
     {
         return $this->level;
     }
@@ -59,15 +59,15 @@ public function getLevel()
      *
      * @return string
      */
-    public function getName()
+    public function getName(): string
     {
         return $this->name;
     }
 
     /**
      * Returns the administrative level short name.
      *
-     * @return string
+     * @return string|null
      */
     public function getCode()
     {
@@ -81,6 +81,6 @@ public function getCode()
      */
     public function __toString(): string
     {
-        return $this->getName() ?: '';
+        return $this->getName();
     }
 }

Model/AdminLevelCollection.php

@@ -119,7 +119,7 @@ public function get(int $level): AdminLevel
     /**
      * @return AdminLevel[]
      */
-    public function all()
+    public function all(): array
     {
         return $this->adminLevels;
     }

Model/Country.php

@@ -18,20 +18,20 @@
 final class Country
 {
     /**
-     * @var string
+     * @var string|null
      */
     private $name;
 
     /**
-     * @var string
+     * @var string|null
      */
     private $code;
 
     /**
      * @param string $name
      * @param string $code
      */
-    public function __construct($name, $code)
+    public function __construct(string $name = null, string $code = null)
     {
         $this->name = $name;
         $this->code = $code;
@@ -40,7 +40,7 @@ public function __construct($name, $code)
     /**
      * Returns the country name.
      *
-     * @return string
+     * @return string|null
      */
     public function getName()
     {
@@ -50,7 +50,7 @@ public function getName()
     /**
      * Returns the country ISO code.
      *
-     * @return string
+     * @return string|null
      */
     public function getCode()
     {

ProviderAggregator.php

@@ -82,7 +82,7 @@ public function geocode(string $value): Collection
     /**
      * {@inheritdoc}
      */
-    public function reverse($latitude, $longitude): Collection
+    public function reverse(float $latitude, float $longitude): Collection
     {
         return $this->reverseQuery(ReverseQuery::create(new Coordinates($latitude, $longitude))
             ->withLimit($this->limit));