Enable PHPStan Level 6 (#1194)

jbelien · web-flow · commit 09d7eefbe64a · 2023-07-31T22:07:24.000+02:00
* Update phpstan.neon

* Update YandexTest.php

* Update TomTomTest.php

* Update PickPointTest.php

* Update PickPoint.php

* Update PhotonTest.php

* Update PeliasTest.php

* Update OpenRouteServiceTest.php

* Update OpenCageTest.php

* Update OpenCage.php

* Update NominatimTest.php

* Update MaxMindBinaryTest.php

* Update MaxMindTest.php

* [WIP] Apply PHPStan fixes

* Apply PHPCSFixer fixes

* [WIP] Apply PHPStan fixes

* [WIP] Apply PHPStan fixes

* Revert "[WIP] Apply PHPStan fixes"

This reverts commit 734c5c52fbcba4bc12cbda07b58d902a79d47891.

* [WIP] Apply PHPStan fixes

* [WIP] Apply PHPStan fixes

* Update phpstan-baseline.neon
diff --git a/Here.php b/Here.php
@@ -73,7 +73,7 @@ final class Here extends AbstractHttpProvider implements Provider
     public const REVERSE_CIT_ENDPOINT_URL_APP_CODE = 'https://reverse.geocoder.cit.api.here.com/6.2/reversegeocode.json';
 
     /**
-     * @var array
+     * @var string[]
      */
     public const GEOCODE_ADDITIONAL_DATA_PARAMS = [
         'CrossingStreets',
@@ -282,6 +282,10 @@ private function getAdditionalDataParam(GeocodeQuery $query): string
 
     /**
      * Add API credentials to query params.
+     *
+     * @param array<string, string> $queryParams
+     *
+     * @return array<string, string>
      */
     private function withApiCredentials(array $queryParams): array
     {
@@ -323,6 +327,8 @@ public function getBaseUrl(Query $query): string
 
     /**
      * Serialize the component query parameter.
+     *
+     * @param array<string, string> $components
      */
     private function serializeComponents(array $components): string
     {
diff --git a/Model/HereAddress.php b/Model/HereAddress.php
@@ -35,12 +35,12 @@ final class HereAddress extends Address
     private $locationName;
 
     /**
-     * @var array|null
+     * @var array<string, mixed>|null
      */
     private $additionalData;
 
     /**
-     * @var array|null
+     * @var array<string, mixed>|null
      */
     private $shape;
 
@@ -93,13 +93,16 @@ public function withLocationName(string $locationName = null): self
     }
 
     /**
-     * @return array|null
+     * @return array<string, mixed>|null
      */
     public function getAdditionalData()
     {
         return $this->additionalData;
     }
 
+    /**
+     * @param array<string, mixed>|null $additionalData
+     */
     public function withAdditionalData(array $additionalData = null): self
     {
         $new = clone $this;
@@ -122,10 +125,7 @@ public function addAdditionalData(string $name, $value = null): self
         return $new;
     }
 
-    /**
-     * @param mixed|null $default
-     */
-    public function getAdditionalDataValue(string $name, $default = null)
+    public function getAdditionalDataValue(string $name, mixed $default = null): mixed
     {
         if ($this->hasAdditionalDataValue($name)) {
             return $this->additionalData[$name];
@@ -139,6 +139,9 @@ public function hasAdditionalDataValue(string $name): bool
         return array_key_exists($name, $this->additionalData);
     }
 
+    /**
+     * @param array<string, mixed>|null $shape
+     */
     public function withShape(array $shape = null): self
     {
         $new = clone $this;
@@ -152,18 +155,15 @@ public function withShape(array $shape = null): self
         return $new;
     }
 
-    /**
-     * @param mixed|null $value
-     */
-    public function addShape(string $name, $value = null): self
+    public function addShape(string $name, mixed $value = null): self
     {
         $new = clone $this;
         $new->shape[$name] = $value;
 
         return $new;
     }
 
-    public function getShapeValue(string $name, $default = null)
+    public function getShapeValue(string $name, mixed $default = null): mixed
     {
         if ($this->hasShapeValue($name)) {
             return $this->shape[$name];
diff --git a/Tests/HereTest.php b/Tests/HereTest.php
@@ -25,7 +25,7 @@
 
 class HereTest extends BaseTestCase
 {
-    protected function getCacheDir()
+    protected function getCacheDir(): ?string
     {
         if (isset($_SERVER['USE_CACHED_RESPONSES']) && true === $_SERVER['USE_CACHED_RESPONSES']) {
             return __DIR__.'/.cached_responses';
@@ -34,7 +34,7 @@ protected function getCacheDir()
         return null;
     }
 
-    public function testGeocodeWithRealAddress()
+    public function testGeocodeWithRealAddress(): void
     {
         if (!isset($_SERVER['HERE_API_KEY'])) {
             $this->markTestSkipped('You need to configure the HERE_API_KEY value in phpunit.xml');
@@ -69,7 +69,7 @@ public function testGeocodeWithRealAddress()
     /**
      * @throws \Geocoder\Exception\Exception
      */
-    public function testGeocodeWithDefaultAdditionalData()
+    public function testGeocodeWithDefaultAdditionalData(): void
     {
         if (!isset($_SERVER['HERE_API_KEY'])) {
             $this->markTestSkipped('You need to configure the HERE_API_KEY value in phpunit.xml');
@@ -111,7 +111,7 @@ public function testGeocodeWithDefaultAdditionalData()
      *
      * @throws \Geocoder\Exception\Exception
      */
-    public function testGeocodeWithAdditionalData()
+    public function testGeocodeWithAdditionalData(): void
     {
         if (!isset($_SERVER['HERE_API_KEY'])) {
             $this->markTestSkipped('You need to configure the HERE_API_KEY value in phpunit.xml');
@@ -161,7 +161,7 @@ public function testGeocodeWithAdditionalData()
      *
      * @throws \Geocoder\Exception\Exception
      */
-    public function testGeocodeWithExtraFilterCountry()
+    public function testGeocodeWithExtraFilterCountry(): void
     {
         if (!isset($_SERVER['HERE_API_KEY'])) {
             $this->markTestSkipped('You need to configure the HERE_API_KEY value in phpunit.xml');
@@ -196,7 +196,7 @@ public function testGeocodeWithExtraFilterCountry()
      *
      * @throws \Geocoder\Exception\Exception
      */
-    public function testGeocodeWithExtraFilterCity()
+    public function testGeocodeWithExtraFilterCity(): void
     {
         if (!isset($_SERVER['HERE_API_KEY'])) {
             $this->markTestSkipped('You need to configure the HERE_API_KEY value in phpunit.xml');
@@ -234,7 +234,7 @@ public function testGeocodeWithExtraFilterCity()
         $this->assertEquals('ESP', $resultCity3->getCountry()->getCode());
     }
 
-    public function testGeocodeWithExtraFilterCounty()
+    public function testGeocodeWithExtraFilterCounty(): void
     {
         if (!isset($_SERVER['HERE_API_KEY'])) {
             $this->markTestSkipped('You need to configure the HERE_API_KEY value in phpunit.xml');
@@ -268,7 +268,7 @@ public function testGeocodeWithExtraFilterCounty()
         $this->assertEquals('ESP', $resultRegion2->getCountry()->getCode());
     }
 
-    public function testReverseWithRealCoordinates()
+    public function testReverseWithRealCoordinates(): void
     {
         if (!isset($_SERVER['HERE_API_KEY'])) {
             $this->markTestSkipped('You need to configure the HERE_API_KEY value in phpunit.xml');
@@ -298,21 +298,21 @@ public function testReverseWithRealCoordinates()
         $this->assertEquals('FRA', $result->getCountry()->getCode());
     }
 
-    public function testGetName()
+    public function testGetName(): void
     {
         $provider = new Here($this->getMockedHttpClient(), 'appId', 'appCode');
         $this->assertEquals('Here', $provider->getName());
     }
 
-    public function testGeocodeWithInvalidData()
+    public function testGeocodeWithInvalidData(): void
     {
         $this->expectException(\Geocoder\Exception\InvalidServerResponse::class);
 
         $provider = new Here($this->getMockedHttpClient(), 'appId', 'appCode');
         $provider->geocodeQuery(GeocodeQuery::create('foobar'));
     }
 
-    public function testGeocodeIpv4()
+    public function testGeocodeIpv4(): void
     {
         $this->expectException(\Geocoder\Exception\UnsupportedOperation::class);
         $this->expectExceptionMessage('The Here provider does not support IP addresses, only street addresses.');
@@ -321,7 +321,7 @@ public function testGeocodeIpv4()
         $provider->geocodeQuery(GeocodeQuery::create('127.0.0.1'));
     }
 
-    public function testGeocodeWithLocalhostIPv6()
+    public function testGeocodeWithLocalhostIPv6(): void
     {
         $this->expectException(\Geocoder\Exception\UnsupportedOperation::class);
         $this->expectExceptionMessage('The Here provider does not support IP addresses, only street addresses.');
@@ -330,7 +330,7 @@ public function testGeocodeWithLocalhostIPv6()
         $provider->geocodeQuery(GeocodeQuery::create('::1'));
     }
 
-    public function testGeocodeInvalidApiKey()
+    public function testGeocodeInvalidApiKey(): void
     {
         $this->expectException(\Geocoder\Exception\InvalidCredentials::class);
         $this->expectExceptionMessage('Invalid or missing api key.');
@@ -349,7 +349,7 @@ public function testGeocodeInvalidApiKey()
         $provider->geocodeQuery(GeocodeQuery::create('New York'));
     }
 
-    public function testGeocodeWithRealIPv6()
+    public function testGeocodeWithRealIPv6(): void
     {
         $this->expectException(\Geocoder\Exception\UnsupportedOperation::class);
         $this->expectExceptionMessage('The Here provider does not support IP addresses, only street addresses.');
@@ -358,7 +358,7 @@ public function testGeocodeWithRealIPv6()
         $provider->geocodeQuery(GeocodeQuery::create('::ffff:88.188.221.14'));
     }
 
-    public function getProvider()
+    public function getProvider(): Here
     {
         if (!isset($_SERVER['HERE_API_KEY'])) {
             $this->markTestSkipped('You need to configure the HERE_API_KEY value in phpunit.xml');
diff --git a/Tests/IntegrationTest.php b/Tests/IntegrationTest.php
@@ -200,7 +200,7 @@ public function testReverseQueryWithNoResults(): void
      * Make sure that a result for a Geocoder is well formatted. Be aware that even
      * a Location with no data may be well formatted.
      */
-    private function assertWellFormattedResult(Collection $result)
+    private function assertWellFormattedResult(Collection $result): void
     {
         $this->assertInstanceOf(
             Collection::class,

Original file line number	Diff line number	Diff line change
`@@ -35,12 +35,12 @@ final class HereAddress extends Address`
`35`	`35`	`private $locationName;`
`36`	`36`
`37`	`37`	`/**`
`38`		`- * @var array\|null`
	`38`	`+ * @var array<string, mixed>\|null`
`39`	`39`	`*/`
`40`	`40`	`private $additionalData;`
`41`	`41`
`42`	`42`	`/**`
`43`		`- * @var array\|null`
	`43`	`+ * @var array<string, mixed>\|null`
`44`	`44`	`*/`
`45`	`45`	`private $shape;`
`46`	`46`
`@@ -93,13 +93,16 @@ public function withLocationName(string $locationName = null): self`
`93`	`93`	`}`
`94`	`94`
`95`	`95`	`/**`
`96`		`- * @return array\|null`
	`96`	`+ * @return array<string, mixed>\|null`
`97`	`97`	`*/`
`98`	`98`	`public function getAdditionalData()`
`99`	`99`	`{`
`100`	`100`	`return $this->additionalData;`
`101`	`101`	`}`
`102`	`102`
	`103`	`+ /**`
	`104`	`+ * @param array<string, mixed>\|null $additionalData`
	`105`	`+ */`
`103`	`106`	`public function withAdditionalData(array $additionalData = null): self`
`104`	`107`	`{`
`105`	`108`	`$new = clone $this;`
`@@ -122,10 +125,7 @@ public function addAdditionalData(string $name, $value = null): self`
`122`	`125`	`return $new;`
`123`	`126`	`}`
`124`	`127`
`125`		`- /**`
`126`		`- * @param mixed\|null $default`
`127`		`- */`
`128`		`- public function getAdditionalDataValue(string $name, $default = null)`
	`128`	`+ public function getAdditionalDataValue(string $name, mixed $default = null): mixed`
`129`	`129`	`{`
`130`	`130`	`if ($this->hasAdditionalDataValue($name)) {`
`131`	`131`	`return $this->additionalData[$name];`
`@@ -139,6 +139,9 @@ public function hasAdditionalDataValue(string $name): bool`
`139`	`139`	`return array_key_exists($name, $this->additionalData);`
`140`	`140`	`}`
`141`	`141`
	`142`	`+ /**`
	`143`	`+ * @param array<string, mixed>\|null $shape`
	`144`	`+ */`
`142`	`145`	`public function withShape(array $shape = null): self`
`143`	`146`	`{`
`144`	`147`	`$new = clone $this;`
`@@ -152,18 +155,15 @@ public function withShape(array $shape = null): self`
`152`	`155`	`return $new;`
`153`	`156`	`}`
`154`	`157`
`155`		`- /**`
`156`		`- * @param mixed\|null $value`
`157`		`- */`
`158`		`- public function addShape(string $name, $value = null): self`
	`158`	`+ public function addShape(string $name, mixed $value = null): self`
`159`	`159`	`{`
`160`	`160`	`$new = clone $this;`
`161`	`161`	`$new->shape[$name] = $value;`
`162`	`162`
`163`	`163`	`return $new;`
`164`	`164`	`}`
`165`	`165`
`166`		`- public function getShapeValue(string $name, $default = null)`
	`166`	`+ public function getShapeValue(string $name, mixed $default = null): mixed`
`167`	`167`	`{`
`168`	`168`	`if ($this->hasShapeValue($name)) {`
`169`	`169`	`return $this->shape[$name];`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@`
`25`	`25`
`26`	`26`	`class HereTest extends BaseTestCase`
`27`	`27`	`{`
`28`		`- protected function getCacheDir()`
	`28`	`+ protected function getCacheDir(): ?string`
`29`	`29`	`{`
`30`	`30`	`if (isset($_SERVER['USE_CACHED_RESPONSES']) && true === $_SERVER['USE_CACHED_RESPONSES']) {`
`31`	`31`	`return __DIR__.'/.cached_responses';`
`@@ -34,7 +34,7 @@ protected function getCacheDir()`
`34`	`34`	`return null;`
`35`	`35`	`}`
`36`	`36`
`37`		`- public function testGeocodeWithRealAddress()`
	`37`	`+ public function testGeocodeWithRealAddress(): void`
`38`	`38`	`{`
`39`	`39`	`if (!isset($_SERVER['HERE_API_KEY'])) {`
`40`	`40`	`$this->markTestSkipped('You need to configure the HERE_API_KEY value in phpunit.xml');`
`@@ -69,7 +69,7 @@ public function testGeocodeWithRealAddress()`
`69`	`69`	`/**`
`70`	`70`	`* @throws \Geocoder\Exception\Exception`
`71`	`71`	`*/`
`72`		`- public function testGeocodeWithDefaultAdditionalData()`
	`72`	`+ public function testGeocodeWithDefaultAdditionalData(): void`
`73`	`73`	`{`
`74`	`74`	`if (!isset($_SERVER['HERE_API_KEY'])) {`
`75`	`75`	`$this->markTestSkipped('You need to configure the HERE_API_KEY value in phpunit.xml');`
`@@ -111,7 +111,7 @@ public function testGeocodeWithDefaultAdditionalData()`
`111`	`111`	`*`
`112`	`112`	`* @throws \Geocoder\Exception\Exception`
`113`	`113`	`*/`
`114`		`- public function testGeocodeWithAdditionalData()`
	`114`	`+ public function testGeocodeWithAdditionalData(): void`
`115`	`115`	`{`
`116`	`116`	`if (!isset($_SERVER['HERE_API_KEY'])) {`
`117`	`117`	`$this->markTestSkipped('You need to configure the HERE_API_KEY value in phpunit.xml');`
`@@ -161,7 +161,7 @@ public function testGeocodeWithAdditionalData()`
`161`	`161`	`*`
`162`	`162`	`* @throws \Geocoder\Exception\Exception`
`163`	`163`	`*/`
`164`		`- public function testGeocodeWithExtraFilterCountry()`
	`164`	`+ public function testGeocodeWithExtraFilterCountry(): void`
`165`	`165`	`{`
`166`	`166`	`if (!isset($_SERVER['HERE_API_KEY'])) {`
`167`	`167`	`$this->markTestSkipped('You need to configure the HERE_API_KEY value in phpunit.xml');`
`@@ -196,7 +196,7 @@ public function testGeocodeWithExtraFilterCountry()`
`196`	`196`	`*`
`197`	`197`	`* @throws \Geocoder\Exception\Exception`
`198`	`198`	`*/`
`199`		`- public function testGeocodeWithExtraFilterCity()`
	`199`	`+ public function testGeocodeWithExtraFilterCity(): void`
`200`	`200`	`{`
`201`	`201`	`if (!isset($_SERVER['HERE_API_KEY'])) {`
`202`	`202`	`$this->markTestSkipped('You need to configure the HERE_API_KEY value in phpunit.xml');`
`@@ -234,7 +234,7 @@ public function testGeocodeWithExtraFilterCity()`
`234`	`234`	`$this->assertEquals('ESP', $resultCity3->getCountry()->getCode());`
`235`	`235`	`}`
`236`	`236`
`237`		`- public function testGeocodeWithExtraFilterCounty()`
	`237`	`+ public function testGeocodeWithExtraFilterCounty(): void`
`238`	`238`	`{`
`239`	`239`	`if (!isset($_SERVER['HERE_API_KEY'])) {`
`240`	`240`	`$this->markTestSkipped('You need to configure the HERE_API_KEY value in phpunit.xml');`
`@@ -268,7 +268,7 @@ public function testGeocodeWithExtraFilterCounty()`
`268`	`268`	`$this->assertEquals('ESP', $resultRegion2->getCountry()->getCode());`
`269`	`269`	`}`
`270`	`270`
`271`		`- public function testReverseWithRealCoordinates()`
	`271`	`+ public function testReverseWithRealCoordinates(): void`
`272`	`272`	`{`
`273`	`273`	`if (!isset($_SERVER['HERE_API_KEY'])) {`
`274`	`274`	`$this->markTestSkipped('You need to configure the HERE_API_KEY value in phpunit.xml');`
`@@ -298,21 +298,21 @@ public function testReverseWithRealCoordinates()`
`298`	`298`	`$this->assertEquals('FRA', $result->getCountry()->getCode());`
`299`	`299`	`}`
`300`	`300`
`301`		`- public function testGetName()`
	`301`	`+ public function testGetName(): void`
`302`	`302`	`{`
`303`	`303`	`$provider = new Here($this->getMockedHttpClient(), 'appId', 'appCode');`
`304`	`304`	`$this->assertEquals('Here', $provider->getName());`
`305`	`305`	`}`
`306`	`306`
`307`		`- public function testGeocodeWithInvalidData()`
	`307`	`+ public function testGeocodeWithInvalidData(): void`
`308`	`308`	`{`
`309`	`309`	`$this->expectException(\Geocoder\Exception\InvalidServerResponse::class);`
`310`	`310`
`311`	`311`	`$provider = new Here($this->getMockedHttpClient(), 'appId', 'appCode');`
`312`	`312`	`$provider->geocodeQuery(GeocodeQuery::create('foobar'));`
`313`	`313`	`}`
`314`	`314`
`315`		`- public function testGeocodeIpv4()`
	`315`	`+ public function testGeocodeIpv4(): void`
`316`	`316`	`{`
`317`	`317`	`$this->expectException(\Geocoder\Exception\UnsupportedOperation::class);`
`318`	`318`	`$this->expectExceptionMessage('The Here provider does not support IP addresses, only street addresses.');`
`@@ -321,7 +321,7 @@ public function testGeocodeIpv4()`
`321`	`321`	`$provider->geocodeQuery(GeocodeQuery::create('127.0.0.1'));`
`322`	`322`	`}`
`323`	`323`
`324`		`- public function testGeocodeWithLocalhostIPv6()`
	`324`	`+ public function testGeocodeWithLocalhostIPv6(): void`
`325`	`325`	`{`
`326`	`326`	`$this->expectException(\Geocoder\Exception\UnsupportedOperation::class);`
`327`	`327`	`$this->expectExceptionMessage('The Here provider does not support IP addresses, only street addresses.');`
`@@ -330,7 +330,7 @@ public function testGeocodeWithLocalhostIPv6()`
`330`	`330`	`$provider->geocodeQuery(GeocodeQuery::create('::1'));`
`331`	`331`	`}`
`332`	`332`
`333`		`- public function testGeocodeInvalidApiKey()`
	`333`	`+ public function testGeocodeInvalidApiKey(): void`
`334`	`334`	`{`
`335`	`335`	`$this->expectException(\Geocoder\Exception\InvalidCredentials::class);`
`336`	`336`	`$this->expectExceptionMessage('Invalid or missing api key.');`
`@@ -349,7 +349,7 @@ public function testGeocodeInvalidApiKey()`
`349`	`349`	`$provider->geocodeQuery(GeocodeQuery::create('New York'));`
`350`	`350`	`}`
`351`	`351`
`352`		`- public function testGeocodeWithRealIPv6()`
	`352`	`+ public function testGeocodeWithRealIPv6(): void`
`353`	`353`	`{`
`354`	`354`	`$this->expectException(\Geocoder\Exception\UnsupportedOperation::class);`
`355`	`355`	`$this->expectExceptionMessage('The Here provider does not support IP addresses, only street addresses.');`
`@@ -358,7 +358,7 @@ public function testGeocodeWithRealIPv6()`
`358`	`358`	`$provider->geocodeQuery(GeocodeQuery::create('::ffff:88.188.221.14'));`
`359`	`359`	`}`
`360`	`360`
`361`		`- public function getProvider()`
	`361`	`+ public function getProvider(): Here`
`362`	`362`	`{`
`363`	`363`	`if (!isset($_SERVER['HERE_API_KEY'])) {`
`364`	`364`	`$this->markTestSkipped('You need to configure the HERE_API_KEY value in phpunit.xml');`
Original file line number	Diff line number	Diff line change
`@@ -200,7 +200,7 @@ public function testReverseQueryWithNoResults(): void`
`200`	`200`	`* Make sure that a result for a Geocoder is well formatted. Be aware that even`
`201`	`201`	`* a Location with no data may be well formatted.`
`202`	`202`	`*/`
`203`		`- private function assertWellFormattedResult(Collection $result)`
	`203`	`+ private function assertWellFormattedResult(Collection $result): void`
`204`	`204`	`{`
`205`	`205`	`$this->assertInstanceOf(`
`206`	`206`	`Collection::class,`