Add PHP 8.1 support by specifying return types for getIterator and count (#1142)

ruudk · web-flow · commit f58f4791aa79 · 2021-12-03T10:13:09.000+01:00
* Test on PHP 8.1

* Specify return types for `getIterator` and `count`

This is required for PHP 8.1.
diff --git a/Model/AddressCollection.php b/Model/AddressCollection.php
@@ -16,6 +16,7 @@
 use Geocoder\Exception\CollectionIsEmpty;
 use Geocoder\Exception\OutOfBounds;
 use Geocoder\Location;
+use Traversable;
 
 final class AddressCollection implements Collection
 {
@@ -35,15 +36,15 @@ public function __construct(array $locations = [])
     /**
      * {@inheritdoc}
      */
-    public function getIterator()
+    public function getIterator(): Traversable
     {
         return new \ArrayIterator($this->all());
     }
 
     /**
      * {@inheritdoc}
      */
-    public function count()
+    public function count(): int
     {
         return count($this->locations);
     }
diff --git a/Model/AdminLevelCollection.php b/Model/AdminLevelCollection.php
@@ -15,6 +15,7 @@
 use Geocoder\Exception\CollectionIsEmpty;
 use Geocoder\Exception\InvalidArgument;
 use Geocoder\Exception\OutOfBounds;
+use Traversable;
 
 /**
  * @author Giorgio Premi <giosh94mhz@gmail.com>
@@ -53,15 +54,15 @@ public function __construct(array $adminLevels = [])
     /**
      * {@inheritdoc}
      */
-    public function getIterator()
+    public function getIterator(): Traversable
     {
         return new \ArrayIterator($this->all());
     }
 
     /**
      * {@inheritdoc}
      */
-    public function count()
+    public function count(): int
     {
         return count($this->adminLevels);
     }

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@`
`16`	`16`	`use Geocoder\Exception\CollectionIsEmpty;`
`17`	`17`	`use Geocoder\Exception\OutOfBounds;`
`18`	`18`	`use Geocoder\Location;`
	`19`	`+use Traversable;`
`19`	`20`
`20`	`21`	`final class AddressCollection implements Collection`
`21`	`22`	`{`
`@@ -35,15 +36,15 @@ public function __construct(array $locations = [])`
`35`	`36`	`/**`
`36`	`37`	`* {@inheritdoc}`
`37`	`38`	`*/`
`38`		`- public function getIterator()`
	`39`	`+ public function getIterator(): Traversable`
`39`	`40`	`{`
`40`	`41`	`return new \ArrayIterator($this->all());`
`41`	`42`	`}`
`42`	`43`
`43`	`44`	`/**`
`44`	`45`	`* {@inheritdoc}`
`45`	`46`	`*/`
`46`		`- public function count()`
	`47`	`+ public function count(): int`
`47`	`48`	`{`
`48`	`49`	`return count($this->locations);`
`49`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@`
`15`	`15`	`use Geocoder\Exception\CollectionIsEmpty;`
`16`	`16`	`use Geocoder\Exception\InvalidArgument;`
`17`	`17`	`use Geocoder\Exception\OutOfBounds;`
	`18`	`+use Traversable;`
`18`	`19`
`19`	`20`	`/**`
`20`	`21`	`* @author Giorgio Premi <[email protected]>`
`@@ -53,15 +54,15 @@ public function __construct(array $adminLevels = [])`
`53`	`54`	`/**`
`54`	`55`	`* {@inheritdoc}`
`55`	`56`	`*/`
`56`		`- public function getIterator()`
	`57`	`+ public function getIterator(): Traversable`
`57`	`58`	`{`
`58`	`59`	`return new \ArrayIterator($this->all());`
`59`	`60`	`}`
`60`	`61`
`61`	`62`	`/**`
`62`	`63`	`* {@inheritdoc}`
`63`	`64`	`*/`
`64`		`- public function count()`
	`65`	`+ public function count(): int`
`65`	`66`	`{`
`66`	`67`	`return count($this->adminLevels);`
`67`	`68`	`}`