divineniiquaye /
flight-routing
| Total Complexity | 64 |
| Total Lines | 314 |
| Duplicated Lines | 0 % |
| Coverage | 98.45% |
| Changes | 16 | ||
| Bugs | 2 | Features | 0 |
Complex classes like RouteMatcher often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use RouteMatcher, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 31 | class RouteMatcher implements RouteMatcherInterface, UrlGeneratorInterface |
||
| 32 | { |
||
| 33 | private RouteCompilerInterface $compiler; |
||
| 34 | |||
| 35 | /** @var RouteCollection|array<int,Route> */ |
||
| 36 | private $routes; |
||
| 37 | |||
| 38 | /** @var array<int,mixed> */ |
||
| 39 | private ?array $compiledData = null; |
||
| 40 | |||
| 41 | /** @var array<int|string,mixed> */ |
||
| 42 | private array $optimized = []; |
||
| 43 | |||
| 44 | 117 | public function __construct(RouteCollection $collection, RouteCompilerInterface $compiler = null) |
|
| 45 | { |
||
| 46 | 117 | $this->compiler = $compiler ?? new RouteCompiler(); |
|
| 47 | 117 | $this->routes = $collection; |
|
| 48 | } |
||
| 49 | |||
| 50 | /** |
||
| 51 | * @internal |
||
| 52 | */ |
||
| 53 | 11 | public function __serialize(): array |
|
| 54 | { |
||
| 55 | 11 | return [$this->compiler->build($this->routes), $this->getRoutes(), $this->compiler]; |
|
|
Bug
introduced
by
|
|||
| 56 | } |
||
| 57 | |||
| 58 | /** |
||
| 59 | * @internal |
||
| 60 | * |
||
| 61 | * @param array<int,mixed> $data |
||
| 62 | */ |
||
| 63 | 12 | public function __unserialize(array $data): void |
|
| 66 | } |
||
| 67 | |||
| 68 | /** |
||
| 69 | * {@inheritdoc} |
||
| 70 | */ |
||
| 71 | 85 | public function matchRequest(ServerRequestInterface $request): ?Route |
|
| 81 | } |
||
| 82 | |||
| 83 | /** |
||
| 84 | * {@inheritdoc} |
||
| 85 | */ |
||
| 86 | 99 | public function match(string $method, UriInterface $uri): ?Route |
|
| 89 | } |
||
| 90 | |||
| 91 | /** |
||
| 92 | * {@inheritdoc} |
||
| 93 | */ |
||
| 94 | 17 | public function generateUri(string $routeName, array $parameters = [], int $referenceType = GeneratedUri::ABSOLUTE_PATH): GeneratedUri |
|
| 95 | { |
||
| 96 | 17 | if (!$optimized = &$this->optimized[$routeName] ?? null) { |
|
| 97 | 17 | foreach ($this->getRoutes() as $offset => $route) { |
|
| 98 | 15 | if ($routeName === $route->getName()) { |
|
| 99 | 15 | if (null === $matched = $this->compiler->generateUri($route, $parameters, $referenceType)) { |
|
| 100 | throw new UrlGenerationException(\sprintf('The route compiler class does not support generating uri for named route: %s', $routeName)); |
||
| 101 | } |
||
| 102 | |||
| 103 | 15 | $optimized = $offset; // Cache the route index ... |
|
| 104 | |||
| 105 | 15 | return $matched; |
|
| 106 | } |
||
| 107 | } |
||
| 108 | |||
| 109 | 2 | throw new UrlGenerationException(\sprintf('Unable to generate a URL for the named route "%s" as such route does not exist.', $routeName), 404); |
|
| 110 | } |
||
| 111 | |||
| 112 | return $this->compiler->generateUri($this->getRoutes()[$optimized], $parameters, $referenceType); |
||
| 113 | } |
||
| 114 | |||
| 115 | /** |
||
| 116 | * Get the compiler associated with this class. |
||
| 117 | */ |
||
| 118 | 6 | public function getCompiler(): RouteCompilerInterface |
|
| 119 | { |
||
| 120 | 6 | return $this->compiler; |
|
| 121 | } |
||
| 122 | |||
| 123 | /** |
||
| 124 | * Get the routes associated with this class. |
||
| 125 | * |
||
| 126 | * @return array<int,Route> |
||
| 127 | */ |
||
| 128 | 30 | public function getRoutes(): array |
|
| 135 | } |
||
| 136 | |||
| 137 | /** |
||
| 138 | * Tries to match a route from a set of routes. |
||
| 139 | */ |
||
| 140 | 94 | protected function matchCollection(string $method, UriInterface $uri, RouteCollection $routes): ?Route |
|
| 141 | { |
||
| 142 | 94 | $requirements = []; |
|
| 143 | 94 | $requestPath = \rawurldecode($uri->getPath()) ?: '/'; |
|
| 144 | 94 | $requestScheme = $uri->getScheme(); |
|
| 145 | |||
| 146 | 94 | foreach ($routes->getRoutes() as $offset => $route) { |
|
| 147 | 93 | if (!empty($staticPrefix = $route->getStaticPrefix()) && !\str_starts_with($requestPath, $staticPrefix)) { |
|
| 148 | 24 | continue; |
|
| 149 | } |
||
| 150 | |||
| 151 | 82 | [$pathRegex, $hostsRegex, $variables] = $this->optimized[$offset] ??= $this->compiler->compile($route); |
|
| 152 | 82 | $hostsVar = []; |
|
| 153 | |||
| 154 | 82 | if (!\preg_match($pathRegex, $requestPath, $matches, \PREG_UNMATCHED_AS_NULL)) { |
|
| 155 | 17 | continue; |
|
| 156 | } |
||
| 157 | |||
| 158 | 71 | if (!$route->hasMethod($method)) { |
|
| 159 | 6 | $requirements[0] = \array_merge($requirements[0] ?? [], $route->getMethods()); |
|
| 160 | 6 | continue; |
|
| 161 | } |
||
| 162 | |||
| 163 | 67 | if (!$route->hasScheme($requestScheme)) { |
|
| 164 | 3 | $requirements[1] = \array_merge($requirements[1] ?? [], $route->getSchemes()); |
|
| 165 | 3 | continue; |
|
| 166 | } |
||
| 167 | |||
| 168 | 65 | if (empty($hostsRegex) || $this->matchHost($hostsRegex, $uri, $hostsVar)) { |
|
| 169 | 63 | if (!empty($variables)) { |
|
| 170 | 25 | $matchInt = 0; |
|
| 171 | |||
| 172 | 25 | foreach ($variables as $key => $value) { |
|
| 173 | 25 | $route->argument($key, $matches[++$matchInt] ?? $matches[$key] ?? $hostsVar[$key] ?? $value); |
|
| 174 | } |
||
| 175 | } |
||
| 176 | |||
| 177 | 63 | return $route; |
|
| 178 | } |
||
| 179 | |||
| 180 | 3 | $requirements[2][] = $hostsRegex; |
|
| 181 | } |
||
| 182 | |||
| 183 | 32 | return $this->assertMatch($method, $uri, $requirements); |
|
| 184 | } |
||
| 185 | |||
| 186 | /** |
||
| 187 | * Tries matching routes from cache. |
||
| 188 | */ |
||
| 189 | 11 | public function matchCached(string $method, UriInterface $uri, array $optimized): ?Route |
|
| 237 | } |
||
| 238 | |||
| 239 | 12 | protected function matchHost(string $hostsRegex, UriInterface $uri, array &$hostsVar): bool |
|
| 256 | } |
||
| 257 | |||
| 258 | /** |
||
| 259 | * @param array<int,mixed> $requirements |
||
| 260 | */ |
||
| 261 | 38 | protected function assertMatch(string $method, UriInterface $uri, array $requirements) |
|
| 278 | } |
||
| 279 | |||
| 280 | /** |
||
| 281 | * @param array<int,string> $requiredMethods |
||
| 282 | */ |
||
| 283 | 6 | protected function assertMethods(string $method, string $uriPath, array $requiredMethods): void |
|
| 284 | { |
||
| 285 | 6 | $allowedMethods = []; |
|
| 286 | |||
| 287 | 6 | foreach (\array_unique($requiredMethods) as $requiredMethod) { |
|
| 288 | 6 | if ($method === $requiredMethod || 'HEAD' === $requiredMethod) { |
|
| 289 | 4 | continue; |
|
| 290 | } |
||
| 291 | |||
| 292 | 6 | $allowedMethods[] = $requiredMethod; |
|
| 293 | } |
||
| 294 | |||
| 295 | 6 | if (!empty($allowedMethods)) { |
|
| 296 | 6 | throw new MethodNotAllowedException($allowedMethods, $uriPath, $method); |
|
| 297 | } |
||
| 298 | } |
||
| 299 | |||
| 300 | /** |
||
| 301 | * @param array<int,string> $requiredSchemes |
||
| 302 | */ |
||
| 303 | 3 | protected function assertSchemes(UriInterface $uri, array $requiredSchemes): void |
|
| 322 | ); |
||
| 323 | } |
||
| 324 | } |
||
| 325 | |||
| 326 | /** |
||
| 327 | * @param array<int,string> $requiredHosts |
||
| 328 | */ |
||
| 329 | 5 | protected function assertHosts(UriInterface $uri, array $requiredHosts): void |
|
| 345 | ); |
||
| 346 | } |
||
| 349 |
Loading history...