Merge pull request #7129 from kenjis/add-phpdoc-type-RouteCollection

refactor: add PHPDoc types in RouteCollection

Author: kenjis

system/Router/RouteCollection.php

@@ -112,8 +112,9 @@ class RouteCollection implements RouteCollectionInterface
      *     verb => [
      *         routeName => [
      *             'route' => [
-     *                 routeKey(or from) => handler,
-     *             ]
+     *                 routeKey(regex) => handler,
+     *             ],
+     *             'redirect' => statusCode,
      *         ]
      *     ],
      * ]
@@ -138,7 +139,7 @@ class RouteCollection implements RouteCollectionInterface
      *
      * [
      *     verb => [
-     *         routeKey(or from) => [
+     *         routeKey(regex) => [
      *             key => value,
      *         ]
      *     ],
@@ -527,6 +528,8 @@ public function getRoutes(?string $verb = null): array
 
     /**
      * Returns one or all routes options
+     *
+     * @return array<string, int|string> [key => value]
      */
     public function getRoutesOptions(?string $from = null, ?string $verb = null): array
     {
@@ -1149,20 +1152,25 @@ public function getFilterForRoute(string $search, ?string $verb = null): string
      *    'role:admin,manager'
      *
      * has a filter of "role", with parameters of ['admin', 'manager'].
+     *
+     * @param string $search routeKey
+     *
+     * @return array<int, string> filter_name or filter_name:arguments like 'role:admin,manager'
+     * @phpstan-return list<string>
      */
     public function getFiltersForRoute(string $search, ?string $verb = null): array
     {
         $options = $this->loadRoutesOptions($verb);
 
-        if (! array_key_exists($search, $options)) {
+        if (! array_key_exists($search, $options) || ! array_key_exists('filter', $options[$search])) {
             return [];
         }
 
         if (is_string($options[$search]['filter'])) {
             return [$options[$search]['filter']];
         }
 
-        return $options[$search]['filter'] ?? [];
+        return $options[$search]['filter'];
     }
 
     /**
@@ -1520,6 +1528,16 @@ public function resetRoutes()
 
     /**
      * Load routes options based on verb
+     *
+     * @return array<string, array<string, array|int|string>> [routeKey(or from) => [key => value]]
+     * @phpstan-return array<
+     *     string,
+     *     array{
+     *         filter?: string|list<string>, namespace?: string, hostname?: string,
+     *         subdomain?: string, offset?: int, priority?: int, as?: string,
+     *         redirect?: string
+     *     }
+     * >
      */
     protected function loadRoutesOptions(?string $verb = null): array
     {