[PP-1] Fix phpdoc return type for RouteProvider::getAllRoutes()

Tagging, as it was created as a result of BSI issue.

In migrate source plugins initializeIterator returns \ArrayIterator which has a return like this * @return \Iterator in the base class. Therefor, this should be right.

+++ b/core/lib/Drupal/Core/Routing/RouteProviderInterface.php
@@ -97,7 +97,7 @@ public function getRoutesByPattern($pattern);
+   * @return iterator|\Symfony\Component\Routing\Route[]

s/iterator/\Iterator

Made the changes suggested in #5. Please review.

Reuploading the interdiff.txt

@ayushmishra206, close but not quite what I was saying in #5.

+++ b/core/lib/Drupal/Core/Routing/RouteProviderInterface.php
@@ -97,7 +97,7 @@ public function getRoutesByPattern($pattern);
+   * @return iterator|\Symfony\Component\Routing\Route[]

iterator should be \Iterator, with a backslash and capital I.

Sorry for my lack of understanding. Updated the patch.

@ayushmishra206, np. thanks for updating the patch.

Off we go!

+++ b/core/lib/Drupal/Core/Routing/RouteProviderInterface.php
@@ -97,7 +97,7 @@ public function getRoutesByPattern($pattern);
    *
-   * @return \Symfony\Component\Routing\Route[]
+   * @return \Iterator|\Symfony\Component\Routing\Route[]
    *   An iterator of routes keyed by route name.
    */

This looks to me like it's returning an iterator of route object arrays - should we be dropping the [] at the end?

Addressed the comment #13
Attached patch against Drupal 10.1.x

Applied patch given in comment #18 in Drupal 10.1.x successfully, image attached

There's https://www.drupal.org/u/needs-review-queue-bot to check patch applicability

@Aziza Anwari please don;t hide working patches

According to https://phpstan.org/blog/solving-phpstan-no-value-type-specified-in-iter... it should be @return \Iterator<string, \Symfony\Component\Routing\Route>

The Needs Review Queue Bot tested this issue. It fails the Drupal core commit checks. Therefore, this issue status is now "Needs work".

Apart from a re-roll or rebase, this issue may need more work to address feedback in the issue or MR comments. To progress an issue, incorporate this feedback as part of the process of updating the issue. This helps other contributors to know what is outstanding.

Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.

ok, no spaces

/**
 * This class allows objects to work as arrays.
 * @link https://php.net/manual/en/class.arrayobject.php
 * @template TKey
 * @template TValue
 * @template-implements IteratorAggregate<TKey, TValue>
 * @template-implements ArrayAccess<TKey, TValue>
 */
class ArrayObject implements IteratorAggregate, ArrayAccess, Serializable, Countable
{

    /**
     * Create a new iterator from an ArrayObject instance
     * @link https://php.net/manual/en/arrayobject.getiterator.php
     * @return ArrayIterator<TKey, TValue> An iterator from an <b>ArrayObject</b>.
     */
    #[TentativeType]
    public function getIterator(): Iterator {}
...

added links to summary phpstan blog and https://github.com/JetBrains/phpstorm-stubs/commit/89f6911ddcc89dd6497ab...

NW for coder issue, it should start work with generics

FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 97 | ERROR | [x] Expected
    |       |     "\Iteratorstring\Symfony\Component\Routing\Route"
    |       |     but found
    |       |     "\Iterator<string,\Symfony\Component\Routing\Route>"
    |       |     for function return type
    |       |     (Drupal.Commenting.FunctionComment.InvalidReturn)

That's how it looks in PhpStorm

Fixed failed commands on #23
Attached patch against Drupal 10.1.x

Here is the interdiff patch against #23 and #27

TRY to Fixed CCF #27

Why are you posting wrong patches?
Did you read comment 24 and articles from it?

Psalm using the same, added to summary https://psalm.dev/docs/annotating_code/templated_annotations/#builtin-te...

It smells like coding standards issue

Created a patch according to the article.

Fixed phpcs failure in #33

I have fixed the CCF error.

+++ b/core/lib/Drupal/Core/Routing/RouteProvider.php
@@ -202,7 +202,7 @@
-    if (!empty($routes)) {
+    if (count($routes) == 0) {

+++ b/core/modules/system/src/Tests/Routing/MockRouteProvider.php
@@ -44,7 +44,7 @@
-    if (!empty($routes)) {
+    if (count($routes) == 0) {

it could be simplified to if (!$routes)

+++ b/core/lib/Drupal/Core/Routing/RouteProviderInterface.php
@@ -67,9 +67,9 @@ public function getRouteByName($name);
+   * @return \Symfony\Component\Routing\Route

@@ -94,7 +94,7 @@ public function getRoutesByPattern($pattern);
-   * @return \Symfony\Component\Routing\Route[]
+   * @return \Symfony\Component\Routing\Route

that's wrong change

Adding patch after considering all senerios.

okay sure, i was too confused why phpcs showing this syntax, as I first tried to follow the article, thanks for raising the issue.

Adding tag.

only coding standards issue left and upgrade of coder to 8.3.18

Using to upgrade coder to 8.3.18 - the patch passing locally

here's 2 patches - final one and fix + coder upgrade