Adding PHP7 scalar type hints (#682)

Nyholm · web-flow · commit 9587868ed3a7 · 2017-06-17T09:05:04.000+02:00
* Adding PHP7 scalar type hints

* cs
diff --git a/Dumper/Dumper.php b/Dumper/Dumper.php
@@ -25,7 +25,7 @@ interface Dumper
      *
      * @param Location $location
      *
-     * @return string
+     * @return mixed
      */
     public function dump(Location $location);
 }
diff --git a/Dumper/GeoArray.php b/Dumper/GeoArray.php
@@ -22,7 +22,7 @@ class GeoArray implements Dumper
     /**
      * {@inheritdoc}
      */
-    public function dump(Location $location)
+    public function dump(Location $location): array
     {
         $properties = array_filter($location->toArray(), function ($value) {
             return !empty($value);
diff --git a/Dumper/GeoJson.php b/Dumper/GeoJson.php
@@ -22,7 +22,7 @@ class GeoJson implements Dumper
     /**
      * {@inheritdoc}
      */
-    public function dump(Location $location)
+    public function dump(Location $location): string
     {
         $properties = array_filter($location->toArray(), function ($value) {
             return !empty($value);
diff --git a/Dumper/Gpx.php b/Dumper/Gpx.php
@@ -25,7 +25,7 @@ class Gpx implements Dumper
      *
      * @return string
      */
-    public function dump(Location $location)
+    public function dump(Location $location): string
     {
         $gpx = sprintf(<<<'GPX'
 <?xml version="1.0" encoding="UTF-8" standalone="no" ?>
@@ -75,7 +75,7 @@ public function dump(Location $location)
      *
      * @return string
      */
-    protected function formatName(Location $address)
+    protected function formatName(Location $address): string
     {
         $name = [];
         $array = $address->toArray();
diff --git a/Dumper/Kml.php b/Dumper/Kml.php
@@ -22,7 +22,7 @@ class Kml extends Gpx implements Dumper
     /**
      * {@inheritdoc}
      */
-    public function dump(Location $location)
+    public function dump(Location $location): string
     {
         $name = $this->formatName($location);
         $kml = <<<'KML'
diff --git a/Dumper/Wkb.php b/Dumper/Wkb.php
@@ -22,7 +22,7 @@ class Wkb implements Dumper
     /**
      * {@inheritdoc}
      */
-    public function dump(Location $location)
+    public function dump(Location $location): string
     {
         $lat = null;
         $lon = null;
diff --git a/Dumper/Wkt.php b/Dumper/Wkt.php
@@ -22,7 +22,7 @@ class Wkt implements Dumper
     /**
      * {@inheritdoc}
      */
-    public function dump(Location $location)
+    public function dump(Location $location): string
     {
         $lat = null;
         $lon = null;
diff --git a/Exception/FunctionNotFound.php b/Exception/FunctionNotFound.php
@@ -21,7 +21,7 @@ class FunctionNotFound extends \RuntimeException implements Exception
      * @param string $functionName
      * @param string $description
      */
-    public function __construct($functionName, $description = null)
+    public function __construct(string $functionName, $description = null)
     {
         parent::__construct(sprintf('The function "%s" cannot be found. %s',
             $functionName,
diff --git a/Exception/InvalidServerResponse.php b/Exception/InvalidServerResponse.php
@@ -25,7 +25,7 @@ class InvalidServerResponse extends \RuntimeException implements Exception
      *
      * @return InvalidServerResponse
      */
-    public static function create($query, $code = 0)
+    public static function create(string $query, int $code = 0): InvalidServerResponse
     {
         return new self(sprintf('The geocoder server returned an invalid response (%d) for query "%s". We could not parse it.', $code, $query));
     }
@@ -35,7 +35,7 @@ public static function create($query, $code = 0)
      *
      * @return InvalidServerResponse
      */
-    public static function emptyResponse($query)
+    public static function emptyResponse(string $query): InvalidServerResponse
     {
         return new self(sprintf('The geocoder server returned an empty response for query "%s".', $query));
     }
diff --git a/Exception/ProviderNotRegistered.php b/Exception/ProviderNotRegistered.php
@@ -21,7 +21,7 @@ class ProviderNotRegistered extends \RuntimeException implements Exception
      * @param string $providerName
      * @param array  $registeredProviders
      */
-    public function __construct($providerName, array $registeredProviders = [])
+    public function __construct(string $providerName, array $registeredProviders = [])
     {
         parent::__construct(sprintf(
             'Provider "%s" is not registered, so you cannot use it. Did you forget to register it or made a typo?%s',
diff --git a/Formatter/StringFormatter.php b/Formatter/StringFormatter.php
@@ -48,7 +48,7 @@ class StringFormatter
      *
      * @return string
      */
-    public function format(Location $location, $format)
+    public function format(Location $location, string $format): string
     {
         if (null !== $code = $location->getCountry()->getCode()) {
             $code = strtoupper($code);
diff --git a/Geocoder.php b/Geocoder.php
@@ -39,7 +39,7 @@ interface Geocoder extends Provider
      *
      * @throws \Geocoder\Exception\Exception
      */
-    public function geocode($value): Collection;
+    public function geocode(string $value): Collection;
 
     /**
      * Reverses geocode given latitude and longitude values.
diff --git a/GeocoderTrait.php b/GeocoderTrait.php
@@ -29,7 +29,7 @@ abstract public function reverseQuery(ReverseQuery $query): Collection;
     /**
      * {@inheritdoc}
      */
-    public function geocode($value): Collection
+    public function geocode(string $value): Collection
     {
         return $this->geocodeQuery(GeocodeQuery::create($value));
     }
diff --git a/Model/AddressBuilder.php b/Model/AddressBuilder.php
@@ -12,8 +12,6 @@
 
 namespace Geocoder\Model;
 
-use Geocoder\Location;
-
 /**
  * A class that builds a Location or any of its subclasses.
  *
@@ -94,7 +92,7 @@ public function __construct(string $providedBy)
      *
      * @return Address
      */
-    public function build($class = Address::class)
+    public function build(string $class = Address::class)
     {
         if (!is_a($class, Address::class, true)) {
             throw new \LogicException('First parameter to LocationBuilder::build must be a class name extending Geocoder\Model\Address');
diff --git a/Model/AdminLevel.php b/Model/AdminLevel.php
@@ -79,8 +79,8 @@ public function getCode()
      *
      * @return string
      */
-    public function __toString()
+    public function __toString(): string
     {
-        return $this->getName();
+        return $this->getName() ?: '';
     }
 }
diff --git a/Provider/AbstractHttpProvider.php b/Provider/AbstractHttpProvider.php
@@ -54,7 +54,7 @@ public function __construct(HttpClient $client, MessageFactory $factory = null)
      *
      * @throws InvalidServerResponse
      */
-    protected function getUrlContents($url)
+    protected function getUrlContents($url): string
     {
         $request = $this->getMessageFactory()->createRequest('GET', $url);
         $response = $this->getHttpClient()->sendRequest($request);
@@ -81,15 +81,15 @@ protected function getUrlContents($url)
      *
      * @return HttpClient
      */
-    protected function getHttpClient()
+    protected function getHttpClient(): HttpClient
     {
         return $this->client;
     }
 
     /**
      * @return MessageFactory
      */
-    protected function getMessageFactory()
+    protected function getMessageFactory(): MessageFactory
     {
         if ($this->messageFactory === null) {
             $this->messageFactory = MessageFactoryDiscovery::find();
@@ -100,25 +100,17 @@ protected function getMessageFactory()
 
     /**
      * @param HttpClient $client
-     *
-     * @return AbstractHttpProvider
      */
     public function setClient(HttpClient $client)
     {
         $this->client = $client;
-
-        return $this;
     }
 
     /**
      * @param MessageFactory $messageFactory
-     *
-     * @return AbstractHttpProvider
      */
     public function setMessageFactory(MessageFactory $messageFactory)
     {
         $this->messageFactory = $messageFactory;
-
-        return $this;
     }
 }
diff --git a/Provider/AbstractProvider.php b/Provider/AbstractProvider.php
@@ -26,7 +26,7 @@ abstract class AbstractProvider
      *
      * @return Location
      */
-    protected function getLocationForLocalhost()
+    protected function getLocationForLocalhost(): Location
     {
         return Address::createFromArray([
             'locality' => 'localhost',
diff --git a/ProviderAggregator.php b/ProviderAggregator.php
@@ -73,7 +73,7 @@ public function getName(): string
     /**
      * {@inheritdoc}
      */
-    public function geocode($value): Collection
+    public function geocode(string $value): Collection
     {
         return $this->geocodeQuery(GeocodeQuery::create($value)
             ->withLimit($this->limit));
@@ -146,7 +146,7 @@ public function registerProviders(array $providers = [])
     public function using($name)
     {
         if (!isset($this->providers[$name])) {
-            throw new ProviderNotRegistered($name);
+            throw new ProviderNotRegistered($name ?? '');
         }
 
         $this->provider = $this->providers[$name];
diff --git a/Query/GeocodeQuery.php b/Query/GeocodeQuery.php
@@ -34,40 +34,38 @@ final class GeocodeQuery
     private $bounds;
 
     /**
-     * @var string
+     * @var string|null
      */
     private $locale;
 
     /**
      * @var int
      */
-    private $limit;
+    private $limit = Geocoder::DEFAULT_RESULT_LIMIT;
 
     /**
      * @var array
      */
-    private $data;
+    private $data = [];
 
     /**
      * @param string $text
      */
-    private function __construct($text)
+    private function __construct(string $text)
     {
         if (empty($text)) {
             throw new InvalidArgument('Geocode query cannot be empty');
         }
 
         $this->text = $text;
-        $this->data = [];
-        $this->limit = Geocoder::DEFAULT_RESULT_LIMIT;
     }
 
     /**
      * @param string $text
      *
      * @return GeocodeQuery
      */
-    public static function create($text)
+    public static function create(string $text): GeocodeQuery
     {
         return new self($text);
     }
@@ -77,7 +75,7 @@ public static function create($text)
      *
      * @return GeocodeQuery
      */
-    public function withBounds(Bounds $bounds)
+    public function withBounds(Bounds $bounds): GeocodeQuery
     {
         $new = clone $this;
         $new->bounds = $bounds;
@@ -90,7 +88,7 @@ public function withBounds(Bounds $bounds)
      *
      * @return GeocodeQuery
      */
-    public function withLocale($locale)
+    public function withLocale(string $locale): GeocodeQuery
     {
         $new = clone $this;
         $new->locale = $locale;
@@ -103,7 +101,7 @@ public function withLocale($locale)
      *
      * @return GeocodeQuery
      */
-    public function withLimit($limit)
+    public function withLimit(int $limit): GeocodeQuery
     {
         $new = clone $this;
         $new->limit = $limit;
@@ -117,7 +115,7 @@ public function withLimit($limit)
      *
      * @return GeocodeQuery
      */
-    public function withData($name, $value)
+    public function withData(string $name, $value): GeocodeQuery
     {
         $new = clone $this;
         $new->data[$name] = $value;
@@ -128,7 +126,7 @@ public function withData($name, $value)
     /**
      * @return string
      */
-    public function getText()
+    public function getText(): string
     {
         return $this->text;
     }
@@ -142,7 +140,7 @@ public function getBounds()
     }
 
     /**
-     * @return string
+     * @return string|null
      */
     public function getLocale()
     {
@@ -152,18 +150,18 @@ public function getLocale()
     /**
      * @return int
      */
-    public function getLimit()
+    public function getLimit(): int
     {
         return $this->limit;
     }
 
     /**
-     * @param string $name
-     * @param null   $default
+     * @param string     $name
+     * @param mixed|null $default
      *
      * @return mixed
      */
-    public function getData($name, $default = null)
+    public function getData(string $name, $default = null)
     {
         if (!array_key_exists($name, $this->data)) {
             return $default;
@@ -175,7 +173,7 @@ public function getData($name, $default = null)
     /**
      * @return array
      */
-    public function getAllData()
+    public function getAllData(): array
     {
         return $this->data;
     }
diff --git a/Query/ReverseQuery.php b/Query/ReverseQuery.php
diff --git a/StatefulGeocoder.php b/StatefulGeocoder.php

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ interface Dumper`
`25`	`25`	`*`
`26`	`26`	`* @param Location $location`
`27`	`27`	`*`
`28`		`- * @return string`
	`28`	`+ * @return mixed`
`29`	`29`	`*/`
`30`	`30`	`public function dump(Location $location);`
`31`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ class GeoArray implements Dumper`
`22`	`22`	`/**`
`23`	`23`	`* {@inheritdoc}`
`24`	`24`	`*/`
`25`		`- public function dump(Location $location)`
	`25`	`+ public function dump(Location $location): array`
`26`	`26`	`{`
`27`	`27`	`$properties = array_filter($location->toArray(), function ($value) {`
`28`	`28`	`return !empty($value);`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ class GeoJson implements Dumper`
`22`	`22`	`/**`
`23`	`23`	`* {@inheritdoc}`
`24`	`24`	`*/`
`25`		`- public function dump(Location $location)`
	`25`	`+ public function dump(Location $location): string`
`26`	`26`	`{`
`27`	`27`	`$properties = array_filter($location->toArray(), function ($value) {`
`28`	`28`	`return !empty($value);`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ class Gpx implements Dumper`
`25`	`25`	`*`
`26`	`26`	`* @return string`
`27`	`27`	`*/`
`28`		`- public function dump(Location $location)`
	`28`	`+ public function dump(Location $location): string`
`29`	`29`	`{`
`30`	`30`	`$gpx = sprintf(<<<'GPX'`
`31`	`31`	`<?xml version="1.0" encoding="UTF-8" standalone="no" ?>`
`@@ -75,7 +75,7 @@ public function dump(Location $location)`
`75`	`75`	`*`
`76`	`76`	`* @return string`
`77`	`77`	`*/`
`78`		`- protected function formatName(Location $address)`
	`78`	`+ protected function formatName(Location $address): string`
`79`	`79`	`{`
`80`	`80`	`$name = [];`
`81`	`81`	`$array = $address->toArray();`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ class Kml extends Gpx implements Dumper`
`22`	`22`	`/**`
`23`	`23`	`* {@inheritdoc}`
`24`	`24`	`*/`
`25`		`- public function dump(Location $location)`
	`25`	`+ public function dump(Location $location): string`
`26`	`26`	`{`
`27`	`27`	`$name = $this->formatName($location);`
`28`	`28`	`$kml = <<<'KML'`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ class Wkb implements Dumper`
`22`	`22`	`/**`
`23`	`23`	`* {@inheritdoc}`
`24`	`24`	`*/`
`25`		`- public function dump(Location $location)`
	`25`	`+ public function dump(Location $location): string`
`26`	`26`	`{`
`27`	`27`	`$lat = null;`
`28`	`28`	`$lon = null;`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ class Wkt implements Dumper`
`22`	`22`	`/**`
`23`	`23`	`* {@inheritdoc}`
`24`	`24`	`*/`
`25`		`- public function dump(Location $location)`
	`25`	`+ public function dump(Location $location): string`
`26`	`26`	`{`
`27`	`27`	`$lat = null;`
`28`	`28`	`$lon = null;`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ class FunctionNotFound extends \RuntimeException implements Exception`
`21`	`21`	`* @param string $functionName`
`22`	`22`	`* @param string $description`
`23`	`23`	`*/`
`24`		`- public function __construct($functionName, $description = null)`
	`24`	`+ public function __construct(string $functionName, $description = null)`
`25`	`25`	`{`
`26`	`26`	`parent::__construct(sprintf('The function "%s" cannot be found. %s',`
`27`	`27`	`$functionName,`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ class InvalidServerResponse extends \RuntimeException implements Exception`
`25`	`25`	`*`
`26`	`26`	`* @return InvalidServerResponse`
`27`	`27`	`*/`
`28`		`- public static function create($query, $code = 0)`
	`28`	`+ public static function create(string $query, int $code = 0): InvalidServerResponse`
`29`	`29`	`{`
`30`	`30`	`return new self(sprintf('The geocoder server returned an invalid response (%d) for query "%s". We could not parse it.', $code, $query));`
`31`	`31`	`}`
`@@ -35,7 +35,7 @@ public static function create($query, $code = 0)`
`35`	`35`	`*`
`36`	`36`	`* @return InvalidServerResponse`
`37`	`37`	`*/`
`38`		`- public static function emptyResponse($query)`
	`38`	`+ public static function emptyResponse(string $query): InvalidServerResponse`
`39`	`39`	`{`
`40`	`40`	`return new self(sprintf('The geocoder server returned an empty response for query "%s".', $query));`
`41`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ class ProviderNotRegistered extends \RuntimeException implements Exception`
`21`	`21`	`* @param string $providerName`
`22`	`22`	`* @param array $registeredProviders`
`23`	`23`	`*/`
`24`		`- public function __construct($providerName, array $registeredProviders = [])`
	`24`	`+ public function __construct(string $providerName, array $registeredProviders = [])`
`25`	`25`	`{`
`26`	`26`	`parent::__construct(sprintf(`
`27`	`27`	`'Provider "%s" is not registered, so you cannot use it. Did you forget to register it or made a typo?%s',`