Merge pull request #279 from andrew-demb/respect-iterable-provider

Fix handling non-array return from route provider

Author: dbu

src/ChainRouteCollection.php

@@ -53,7 +53,7 @@ public function add(string $name, Route $route, int $priority = 0): void
     /**
      * Returns all routes in this collection.
      *
-     * @return Route[] An array of routes
+     * @return array<string, Route> An array of routes
      */
     public function all(): array
     {

src/LazyRouteCollection.php

@@ -35,11 +35,16 @@ public function count(): int
     /**
      * Returns all routes in this collection.
      *
-     * @return Route[] An array of routes
+     * @return array<string, Route> An array of routes
      */
     public function all(): array
     {
-        return $this->provider->getRoutesByNames(null);
+        $routes = $this->provider->getRoutesByNames(null);
+        if (\is_array($routes)) {
+            return $routes;
+        }
+
+        return \iterator_to_array($routes);
     }
 
     public function get(string $name): ?Route

src/RouteProviderInterface.php

@@ -77,7 +77,7 @@ public function getRouteByName(string $name): SymfonyRoute;
      * @param string[]|null $names The list of names to retrieve, In case of null,
      *                             the provider will determine what routes to return
      *
-     * @return SymfonyRoute[] Iterable list with the keys being the names from the $names array
+     * @return iterable<string, SymfonyRoute> Iterable list with the keys being the names from the $names array
      */
     public function getRoutesByNames(?array $names = null): iterable;
 }

tests/Unit/Routing/LazyRouteCollectionTest.php

@@ -36,7 +36,7 @@ public function testGetIterator(): void
         $routeProvider->expects($this->exactly(2))
             ->method('getRoutesByNames')
             ->with(null)
-            ->willReturn($testRoutes);
+            ->willReturn(new \ArrayIterator($testRoutes));
         $lazyRouteCollection = new LazyRouteCollection($routeProvider);
         $this->assertEquals($testRoutes, iterator_to_array($lazyRouteCollection->getIterator()));
         $this->assertEquals($testRoutes, $lazyRouteCollection->all());