Centralise array shape definitions

This makes things much less error-prone. Signed-off-by: Luís Cobucci <[email protected]>
nikic · Jan 8, 2024 · ca2ea1b · ca2ea1b
1 parent 9af18eb
commit ca2ea1b
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 9 deletions.
diff --git a/src/Cache.php b/src/Cache.php
@@ -3,12 +3,13 @@
 
 namespace FastRoute;
 
+/** @phpstan-import-type RouteData from DataGenerator */
 interface Cache
 {
     /**
-     * @param callable():array{0: array<string, array<string, mixed>>, 1: array<string, array<array{regex: string, suffix?: string, routeMap: array<int|string, array{0: mixed, 1: array<string, string>}>}>>} $loader
+     * @param callable():RouteData $loader
      *
-     * @return array{0: array<string, array<string, mixed>>, 1: array<string, array<array{regex: string, suffix?: string, routeMap: array<int|string, array{0: mixed, 1: array<string, string>}>}>>}
+     * @return RouteData
      */
     public function get(string $key, callable $loader): array;
 }
diff --git a/src/DataGenerator.php b/src/DataGenerator.php
@@ -3,6 +3,12 @@
 
 namespace FastRoute;
 
+/**
+ * @phpstan-type StaticRoutes array<string, array<string, mixed>>
+ * @phpstan-type DynamicRouteChunk array{regex: string, suffix?: string, routeMap: array<int|string, array{0: mixed, 1: array<string, string>}>}
+ * @phpstan-type DynamicRoutes array<string, list<DynamicRouteChunk>>
+ * @phpstan-type RouteData array{StaticRoutes, DynamicRoutes}
+ */
 interface DataGenerator
 {
     /**
@@ -21,7 +27,7 @@ public function addRoute(string $httpMethod, array $routeData, mixed $handler):
      * Returns dispatcher data in some unspecified format, which
      * depends on the used method of dispatch.
      *
-     * @return array{0: array<string, array<string, mixed>>, 1: array<string, array<array{regex: string, suffix?: string, routeMap: array<int|string, array{0: mixed, 1: array<string, string>}>}>>}
+     * @return RouteData
      */
     public function getData(): array;
 }
diff --git a/src/DataGenerator/RegexBasedAbstract.php b/src/DataGenerator/RegexBasedAbstract.php
@@ -16,9 +16,15 @@
 use function max;
 use function round;
 
+/**
+ * @phpstan-import-type StaticRoutes from DataGenerator
+ * @phpstan-import-type DynamicRouteChunk from DataGenerator
+ * @phpstan-import-type DynamicRoutes from DataGenerator
+ * @phpstan-import-type RouteData from DataGenerator
+ */
 abstract class RegexBasedAbstract implements DataGenerator
 {
-    /** @var array<string, array<string, mixed>> */
+    /** @var StaticRoutes */
     protected array $staticRoutes = [];
 
     /** @var array<string, array<string, Route>> */
@@ -29,7 +35,7 @@ abstract protected function getApproxChunkSize(): int;
     /**
      * @param array<string, Route> $regexToRoutesMap
      *
-     * @return array{regex: string, suffix?: string, routeMap: array<int|string, array{0: mixed, 1: array<string, string>}>}
+     * @return DynamicRouteChunk
      */
     abstract protected function processChunk(array $regexToRoutesMap): array;
 
@@ -53,7 +59,7 @@ public function getData(): array
         return [$this->staticRoutes, $this->generateVariableRouteData()];
     }
 
-    /** @return array<string, array<array{regex: string, suffix?: string, routeMap: array<int|string, array{0: mixed, 1: array<string, string>}>}>> */
+    /** @return DynamicRoutes */
     private function generateVariableRouteData(): array
     {
         $data = [];

diff --git a/src/Dispatcher/RegexBasedAbstract.php b/src/Dispatcher/RegexBasedAbstract.php
@@ -3,20 +3,26 @@
 
 namespace FastRoute\Dispatcher;
 
+use FastRoute\DataGenerator;
 use FastRoute\Dispatcher;
 use FastRoute\Dispatcher\Result\Matched;
 use FastRoute\Dispatcher\Result\MethodNotAllowed;
 use FastRoute\Dispatcher\Result\NotMatched;
 
+/**
+ * @phpstan-import-type StaticRoutes from DataGenerator
+ * @phpstan-import-type DynamicRoutes from DataGenerator
+ * @phpstan-import-type RouteData from DataGenerator
+ */
 abstract class RegexBasedAbstract implements Dispatcher
 {
-    /** @var array<string, array<string, mixed>> */
+    /** @var StaticRoutes */
     protected array $staticRouteMap = [];
 
-    /** @var array<string, array<array{regex: string, suffix?: string, routeMap: array<int|string, array{0: mixed, 1: array<string, string>}>}>> */
+    /** @var DynamicRoutes */
     protected array $variableRouteData = [];
 
-    /** @param array{0: array<string, array<string, mixed>>, 1: array<string, array<array{regex: string, suffix?: string, routeMap: array<int|string, array{0: mixed, 1: array<string, string>}>}>>} $data */
+    /** @param RouteData $data */
     public function __construct(array $data)
     {
         [$this->staticRouteMap, $this->variableRouteData] = $data;