RouteProvider::getAllRoutes no longer returns an iterable, breaking BC

Is this breaking a contrib module? Or otherwise how did you spot the change?

We currently don't have a clear policy for when implementations fail to match interfaces (i.e. whether changing the interface or the implementation should be considered the bc break). The description and type hint in the interface contradict each other: https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Routing%2...

If we want to change the interface and keep the older implementation, then we should just go ahead and return an iterator again. Wrapping the array in ArrayObject is easy but does PHP have anything lighter these days?

afaict ArrayObject is still the simplest option here. Here's a patch with test coverage.

Looks nice and simple :)

+1 rtbc

RouteProviderInterface still says this:

   * @return \Symfony\Component\Routing\Route[]
   *   An iterator of routes keyed by route name.

I thought [] meant an array, not an iterator. How do you tell the difference in PHPDoc comments?

Thanks,
-Derek

Do we want to add BC warning here?

Do we want to add BC warning here?

I don't think we do, because this was only in 9.1

Committed c6aa9bc and pushed to 9.1.x. Thanks!

Re #8 I don't think we're consistent

E.g. We have \Drupal\migrate\Plugin\MigrateIdMapInterface::getMessages, \Drupal\migrate\Plugin\MigrateIdMapInterface::getMessageIterator amongst others.

As this is a critical and we don't want it to ship in a tagged release, committed as is. Can we get a follow-up for #8?

Tagging as this was flagged in the #bugsmash channel which led me here

Re: #12:
#3161129: [PP-1] Fix phpdoc return type for RouteProvider::getAllRoutes()

Cheers,
-Derek