blitz-php /
framework
| Total Complexity | 53 |
| Total Lines | 477 |
| Duplicated Lines | 0 % |
| Changes | 2 | ||
| Bugs | 1 | Features | 0 |
Complex classes like Router 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 Router, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 30 | class Router implements RouterInterface |
||
| 31 | { |
||
| 32 | /** |
||
| 33 | * Une instance de la classe RouteCollection. |
||
| 34 | * |
||
| 35 | * @var RouteCollection |
||
| 36 | */ |
||
| 37 | protected $collection; |
||
| 38 | |||
| 39 | /** |
||
| 40 | * Sous-répertoire contenant la classe de contrôleur demandée. |
||
| 41 | * Principalement utilisé par 'autoRoute'. |
||
| 42 | */ |
||
| 43 | protected ?string $directory = null; |
||
| 44 | |||
| 45 | /** |
||
| 46 | * Le nom de la classe contrôleur |
||
| 47 | * |
||
| 48 | * @var Closure|string |
||
|
Bug
introduced
by
|
|||
| 49 | */ |
||
| 50 | protected $controller; |
||
| 51 | |||
| 52 | /** |
||
| 53 | * Le nom de la méthode à utiliser |
||
| 54 | */ |
||
| 55 | protected string $method = ''; |
||
| 56 | |||
| 57 | /** |
||
| 58 | * Un tableau de liens qui ont été collectés afin |
||
| 59 | * qu'ils puissent être envoyés aux routes de fermeture. |
||
| 60 | */ |
||
| 61 | protected array $params = []; |
||
| 62 | |||
| 63 | /** |
||
| 64 | * Le nom du du front-controller. |
||
| 65 | */ |
||
| 66 | protected string $indexPage = 'index.php'; |
||
| 67 | |||
| 68 | /** |
||
| 69 | * Si les tirets dans les URI doivent être convertis |
||
| 70 | * pour les traits de soulignement lors de la détermination des noms de méthode. |
||
| 71 | */ |
||
| 72 | protected bool $translateURIDashes = true; |
||
| 73 | |||
| 74 | /** |
||
| 75 | * Les routes trouvées pour la requête courrante |
||
| 76 | */ |
||
| 77 | protected ?array $matchedRoute = null; |
||
| 78 | |||
| 79 | /** |
||
| 80 | * Les options de la route matchée. |
||
| 81 | */ |
||
| 82 | protected ?array $matchedRouteOptions = null; |
||
| 83 | |||
| 84 | /** |
||
| 85 | * Le locale (langue) qui a été detectée dans la route. |
||
| 86 | * |
||
| 87 | * @var string |
||
| 88 | */ |
||
| 89 | protected $detectedLocale; |
||
| 90 | |||
| 91 | /** |
||
| 92 | * Les informations des middlewares à executer |
||
| 93 | * Si la route matchée necessite des filtres. |
||
| 94 | * |
||
| 95 | * @var string[] |
||
| 96 | */ |
||
| 97 | protected array $middlewaresInfo = []; |
||
| 98 | |||
| 99 | protected ?AutoRouterInterface $autoRouter = null; |
||
| 100 | |||
| 101 | /** |
||
| 102 | * @param Request $request |
||
| 103 | * |
||
| 104 | * @return self |
||
| 105 | */ |
||
| 106 | public function __construct(RouteCollectionInterface $routes, ServerRequestInterface $request) |
||
| 107 | { |
||
| 108 | $this->collection = $routes; |
||
| 109 | |||
| 110 | $this->setController($this->collection->getDefaultController()); |
||
| 111 | $this->setMethod($this->collection->getDefaultMethod()); |
||
| 112 | |||
| 113 | $this->collection->setHTTPVerb($request->getMethod() ?? $_SERVER['REQUEST_METHOD']); |
||
| 114 | |||
| 115 | $this->translateURIDashes = $this->collection->shouldTranslateURIDashes(); |
||
| 116 | |||
| 117 | if ($this->collection->shouldAutoRoute()) { |
||
| 118 | $this->autoRouter = new AutoRouter( |
||
| 119 | $this->collection->getRegisteredControllers('*'), |
||
| 120 | $this->collection->getDefaultNamespace(), |
||
| 121 | $this->collection->getDefaultController(), |
||
| 122 | $this->collection->getDefaultMethod(), |
||
| 123 | $this->translateURIDashes |
||
| 124 | ); |
||
| 125 | } |
||
| 126 | } |
||
| 127 | |||
| 128 | /** |
||
| 129 | * @return Closure|string Nom de classe du contrôleur ou closure |
||
| 130 | * |
||
| 131 | * @throws PageNotFoundException |
||
| 132 | * @throws RedirectException |
||
| 133 | */ |
||
| 134 | public function handle(?string $uri = null) |
||
| 135 | { |
||
| 136 | // Si nous ne trouvons pas d'URI à comparer, alors |
||
| 137 | // tout fonctionne à partir de ses paramètres par défaut. |
||
| 138 | if ($uri === null || $uri === '') { |
||
| 139 | $uri = '/'; |
||
| 140 | } |
||
| 141 | |||
| 142 | $uri = urldecode($uri); |
||
| 143 | $this->middlewaresInfo = []; |
||
| 144 | |||
| 145 | if ($this->checkRoutes($uri)) { |
||
| 146 | if ($this->collection->isFiltered($this->matchedRoute[0])) { |
||
| 147 | $this->middlewaresInfo = $this->collection->getFiltersForRoute($this->matchedRoute[0]); |
||
| 148 | } |
||
| 149 | |||
| 150 | // met a jour le routeur dans le conteneur car permet notament de recupere les bonnes |
||
| 151 | // info du routing (route actuelle, controleur et methode mappés) |
||
| 152 | Services::set(static::class, $this); |
||
| 153 | |||
| 154 | return $this->controllerName(); |
||
| 155 | } |
||
| 156 | |||
| 157 | // Toujours là ? Ensuite, nous pouvons essayer de faire correspondre l'URI avec |
||
| 158 | // Contrôleurs/répertoires, mais l'application peut ne pas |
||
| 159 | // vouloir ceci, comme dans le cas des API. |
||
| 160 | if (! $this->collection->shouldAutoRoute()) { |
||
| 161 | throw new PageNotFoundException("Impossible de trouver une route pour '{$this->collection->getHTTPVerb()}: {$uri}'."); |
||
| 162 | } |
||
| 163 | |||
| 164 | $this->autoRoute($uri); |
||
| 165 | |||
| 166 | // met a jour le routeur dans le conteneur car permet notament de recupere les bonnes |
||
| 167 | // info du routing (route actuelle, controleur et methode mappés) |
||
| 168 | Services::set(static::class, $this); |
||
| 169 | |||
| 170 | return $this->controllerName(); |
||
| 171 | } |
||
| 172 | |||
| 173 | /** |
||
| 174 | * Renvoie les informations des middlewares de la routes matchée |
||
| 175 | * |
||
| 176 | * @return string[] |
||
| 177 | */ |
||
| 178 | public function getMiddlewares(): array |
||
| 179 | { |
||
| 180 | return $this->middlewaresInfo; |
||
| 181 | } |
||
| 182 | |||
| 183 | /** |
||
| 184 | * Renvoie le nom du contrôleur matché |
||
| 185 | * |
||
| 186 | * @return closure|string |
||
| 187 | */ |
||
| 188 | public function controllerName() |
||
| 189 | { |
||
| 190 | if (! is_string($this->controller)) { |
||
| 191 | return $this->controller; |
||
| 192 | } |
||
| 193 | |||
| 194 | $controller = preg_replace( |
||
| 195 | ['#(\_)?Controller$#i', '#' . config('app.url_suffix') . '$#i'], |
||
| 196 | '', |
||
| 197 | ucfirst($this->controller) |
||
| 198 | ) . 'Controller'; |
||
| 199 | |||
| 200 | return $this->translateURIDashes |
||
| 201 | ? str_replace('-', '_', trim($controller, '/\\')) |
||
| 202 | : Text::toPascalCase($controller); |
||
| 203 | } |
||
| 204 | |||
| 205 | /** |
||
| 206 | * Retourne le nom de la méthode à exécuter |
||
| 207 | */ |
||
| 208 | public function methodName(): string |
||
| 209 | { |
||
| 210 | return $this->translateURIDashes |
||
| 211 | ? str_replace('-', '_', $this->method) |
||
| 212 | : $this->method; |
||
| 213 | } |
||
| 214 | |||
| 215 | /** |
||
| 216 | * Renvoie les paramètres de remplacement 404 de la collection. |
||
| 217 | * Si le remplacement est une chaîne, sera divisé en tableau contrôleur/index. |
||
| 218 | * |
||
| 219 | * @return array|callable|null |
||
| 220 | */ |
||
| 221 | public function get404Override() |
||
| 222 | { |
||
| 223 | $route = $this->collection->get404Override(); |
||
| 224 | |||
| 225 | if (is_string($route)) { |
||
| 226 | $routeArray = explode('::', $route); |
||
| 227 | |||
| 228 | return [ |
||
| 229 | $routeArray[0], // Controller |
||
| 230 | $routeArray[1] ?? 'index', // Method |
||
| 231 | ]; |
||
| 232 | } |
||
| 233 | |||
| 234 | if (is_callable($route)) { |
||
| 235 | return $route; |
||
| 236 | } |
||
| 237 | |||
| 238 | return null; |
||
| 239 | } |
||
| 240 | |||
| 241 | /** |
||
| 242 | * Renvoie les liaisons qui ont été mises en correspondance et collectées |
||
| 243 | * pendant le processus d'analyse sous forme de tableau, prêt à être envoyé à |
||
| 244 | * instance->method(...$params). |
||
| 245 | */ |
||
| 246 | public function params(): array |
||
| 247 | { |
||
| 248 | return $this->params; |
||
| 249 | } |
||
| 250 | |||
| 251 | /** |
||
| 252 | * Renvoie le nom du sous-répertoire dans lequel se trouve le contrôleur. |
||
| 253 | * Relatif à APPPATH.'Controllers'. |
||
| 254 | * |
||
| 255 | * Uniquement utilisé lorsque le routage automatique est activé. |
||
| 256 | */ |
||
| 257 | public function directory(): string |
||
| 258 | { |
||
| 259 | if ($this->autoRouter instanceof AutoRouter) { |
||
| 260 | return $this->autoRouter->directory(); |
||
| 261 | } |
||
| 262 | |||
| 263 | return ''; |
||
| 264 | } |
||
| 265 | |||
| 266 | /** |
||
| 267 | * Renvoie les informations de routage qui correspondaient à ce |
||
| 268 | * requête, si une route a été définie. |
||
| 269 | */ |
||
| 270 | public function getMatchedRoute(): ?array |
||
| 273 | } |
||
| 274 | |||
| 275 | /** |
||
| 276 | * Renvoie toutes les options définies pour la route correspondante |
||
| 277 | */ |
||
| 278 | public function getMatchedRouteOptions(): ?array |
||
| 279 | { |
||
| 280 | return $this->matchedRouteOptions; |
||
| 281 | } |
||
| 282 | |||
| 283 | /** |
||
| 284 | * Définit la valeur qui doit être utilisée pour correspondre au fichier index.php. Valeurs par défaut |
||
| 285 | * à index.php mais cela vous permet de le modifier au cas où vous utilisez |
||
| 286 | * quelque chose comme mod_rewrite pour supprimer la page. Vous pourriez alors le définir comme une chaine vide= |
||
| 287 | */ |
||
| 288 | public function setIndexPage(string $page): self |
||
| 289 | { |
||
| 290 | $this->indexPage = $page; |
||
| 291 | |||
| 292 | return $this; |
||
| 293 | } |
||
| 294 | |||
| 295 | /** |
||
| 296 | * Renvoie vrai/faux selon que la route actuelle contient ou non |
||
| 297 | * un placeholder {locale}. |
||
| 298 | */ |
||
| 299 | public function hasLocale(): bool |
||
| 300 | { |
||
| 301 | return (bool) $this->detectedLocale; |
||
| 302 | } |
||
| 303 | |||
| 304 | /** |
||
| 305 | * Renvoie la locale (langue) détectée, le cas échéant, ou null. |
||
| 306 | */ |
||
| 307 | public function getLocale(): ?string |
||
| 310 | } |
||
| 311 | |||
| 312 | /** |
||
| 313 | * Compare la chaîne uri aux routes que la |
||
| 314 | * classe RouteCollection a définie pour nous, essayant de trouver une correspondance. |
||
| 315 | * Cette méthode modifiera $this->controller, si nécessaire. |
||
| 316 | * |
||
| 317 | * @param string $uri Le chemin URI à comparer aux routes |
||
| 318 | * |
||
| 319 | * @return bool Si la route a été mis en correspondance ou non. |
||
| 320 | * |
||
| 321 | * @throws RedirectException |
||
| 322 | */ |
||
| 323 | protected function checkRoutes(string $uri): bool |
||
| 429 | } |
||
| 430 | |||
| 431 | /** |
||
| 432 | * Tente de faire correspondre un chemin d'URI avec des contrôleurs et des répertoires |
||
| 433 | * trouvé dans CONTROLLER_PATH, pour trouver une route correspondante. |
||
| 434 | */ |
||
| 435 | public function autoRoute(string $uri) |
||
| 436 | { |
||
| 437 | [$this->directory, $this->controller, $this->method, $this->params] |
||
| 438 | = $this->autoRouter->getRoute($uri, $this->collection->getHTTPVerb()); |
||
| 439 | } |
||
| 440 | |||
| 441 | /** |
||
| 442 | * Définir la route de la requête |
||
| 443 | * |
||
| 444 | * Prend un tableau de segments URI en entrée et définit la classe/méthode |
||
| 445 | * être appelé. |
||
| 446 | * |
||
| 447 | * @param array $segments segments d'URI |
||
| 448 | */ |
||
| 449 | protected function setRequest(array $segments = []) |
||
| 450 | { |
||
| 451 | // Si nous n'avons aucun segment - essayez le contrôleur par défaut ; |
||
| 452 | if (empty($segments)) { |
||
| 453 | return; |
||
| 454 | } |
||
| 455 | |||
| 456 | [$controller, $method] = array_pad(explode('::', $segments[0]), 2, null); |
||
| 457 | |||
| 458 | $this->setController($controller); |
||
| 459 | |||
| 460 | // $this->method contient déjà le nom de la méthode par défaut, |
||
| 461 | // donc ne l'écrasez pas avec le vide. |
||
| 462 | if (! empty($method)) { |
||
| 463 | $this->setMethod($method); |
||
| 464 | } |
||
| 465 | |||
| 466 | array_shift($segments); |
||
| 467 | |||
| 468 | $this->params = $segments; |
||
| 469 | } |
||
| 470 | |||
| 471 | /** |
||
| 472 | * Modifie le nom du controleur |
||
| 473 | */ |
||
| 474 | private function setController(string $name): void |
||
| 477 | } |
||
| 478 | |||
| 479 | /** |
||
| 480 | * Construit un nom de contrôleur valide |
||
| 481 | */ |
||
| 482 | private function makeController(string $name): string |
||
| 483 | { |
||
| 484 | if ($this->autoRouter instanceof AutoRouter) { |
||
| 485 | return $this->autoRouter->makeController($name); |
||
| 486 | } |
||
| 487 | |||
| 488 | return $name; |
||
| 489 | } |
||
| 490 | |||
| 491 | /** |
||
| 492 | * Modifie le nom de la méthode |
||
| 493 | */ |
||
| 494 | private function setMethod(string $name): void |
||
| 497 | } |
||
| 498 | |||
| 499 | /** |
||
| 500 | * @param callable|string $handler |
||
| 501 | */ |
||
| 502 | protected function setMatchedRoute(string $route, $handler): void |
||
| 503 | { |
||
| 504 | $this->matchedRoute = [$route, $handler]; |
||
| 505 | |||
| 506 | $this->matchedRouteOptions = $this->collection->getRoutesOptions($route); |
||
| 507 | } |
||
| 508 | } |
||
| 509 |
Loading history...