docs: add PHPDoc types

codeigniter4 · Jan 16, 2023 · ffce097 · ffce097
1 parent cc14fdd
commit ffce097
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/system/Router/RouteCollection.php b/system/Router/RouteCollection.php
@@ -527,6 +527,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,6 +1151,11 @@ 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
     {
@@ -1520,6 +1527,15 @@ 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
+     *     }
+     * >
      */
     protected function loadRoutesOptions(?string $verb = null): array
     {