refactor: system/Debug/Toolbar/Collectors/Routes.php

codeigniter4 · Apr 10, 2024 · 4fa96ba · 4fa96ba
1 parent 2c524fd
commit 4fa96ba
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 5 deletions.
diff --git a/phpstan-baseline.php b/phpstan-baseline.php
@@ -4466,11 +4466,6 @@
 	'count' => 1,
 	'path' => __DIR__ . '/system/Debug/Toolbar/Collectors/Logs.php',
 ];
-$ignoreErrors[] = [
-	'message' => '#^Method CodeIgniter\\\\Debug\\\\Toolbar\\\\Collectors\\\\Routes\\:\\:display\\(\\) return type has no value type specified in iterable type array\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Debug/Toolbar/Collectors/Routes.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^Method CodeIgniter\\\\Debug\\\\Toolbar\\\\Collectors\\\\Timers\\:\\:formatTimelineData\\(\\) return type has no value type specified in iterable type array\\.$#',
 	'count' => 1,

diff --git a/system/Debug/Toolbar/Collectors/Routes.php b/system/Debug/Toolbar/Collectors/Routes.php
@@ -51,6 +51,25 @@ class Routes extends BaseCollector
     /**
      * Returns the data of this collector to be formatted in the toolbar
      *
+     * @return array{
+     *      matchedRoute: array<array{
+     *          directory: string,
+     *          controller: string,
+     *          method: string,
+     *          paramCount: int,
+     *          truePCount: int,
+     *          params: array<array{
+     *              name: string,
+     *              value: mixed
+     *          }>
+     *      }>,
+     *      routes: array<array{
+     *          method: string,
+     *          route: string,
+     *          handler: string
+     *      }>
+     * }
+     *
      * @throws ReflectionException
      */
     public function display(): array