kokororin /
Kotori.php
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like Route 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. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
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 Route, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 47 | class Route |
||
| 48 | { |
||
| 49 | /** |
||
| 50 | * Controllers Array |
||
| 51 | * |
||
| 52 | * @var array |
||
| 53 | */ |
||
| 54 | protected $controllers = []; |
||
| 55 | |||
| 56 | /** |
||
| 57 | * Current controller |
||
| 58 | * |
||
| 59 | * @var string |
||
| 60 | */ |
||
| 61 | protected $controller; |
||
| 62 | |||
| 63 | /** |
||
| 64 | * Current action |
||
| 65 | * |
||
| 66 | * @var string |
||
| 67 | */ |
||
| 68 | protected $action; |
||
| 69 | |||
| 70 | /** |
||
| 71 | * Current URI string |
||
| 72 | * |
||
| 73 | * @var mixed |
||
| 74 | */ |
||
| 75 | protected $uri = ''; |
||
| 76 | |||
| 77 | /** |
||
| 78 | * Parsed URI Array |
||
| 79 | * |
||
| 80 | * @var array |
||
| 81 | */ |
||
| 82 | protected $uris = []; |
||
| 83 | |||
| 84 | /** |
||
| 85 | * Parsed params |
||
| 86 | * |
||
| 87 | * @var array |
||
| 88 | */ |
||
| 89 | protected $params = []; |
||
| 90 | |||
| 91 | /** |
||
| 92 | * Parsed routes |
||
| 93 | * |
||
| 94 | * @var array |
||
| 95 | */ |
||
| 96 | protected $routes = []; |
||
| 97 | |||
| 98 | /** |
||
| 99 | * Class constructor |
||
| 100 | * |
||
| 101 | * Initialize route class. |
||
| 102 | */ |
||
| 103 | 1 | public function __construct() |
|
| 104 | { |
||
| 105 | 1 | if (Container::get('request')->isCli()) { |
|
| 106 | 1 | $this->uri = $this->parseArgv(); |
|
| 107 | } else { |
||
| 108 | if (isset($_GET['_i'])) { |
||
| 109 | $_SERVER['PATH_INFO'] = $_GET['_i']; |
||
| 110 | } |
||
| 111 | |||
| 112 | $_SERVER['PATH_INFO'] = isset($_SERVER['PATH_INFO']) ? $_SERVER['PATH_INFO'] |
||
| 113 | : (isset($_SERVER['ORIG_PATH_INFO']) ? $_SERVER['ORIG_PATH_INFO'] |
||
| 114 | : (isset($_SERVER['REDIRECT_PATH_INFO']) ? $_SERVER['REDIRECT_PATH_INFO'] : '')); |
||
| 115 | |||
| 116 | $this->uri = $_SERVER['PATH_INFO']; |
||
| 117 | } |
||
| 118 | |||
| 119 | 1 | if (substr($this->uri, 0, 1) == '/') { |
|
| 120 | $this->uri = ltrim($this->uri, '/'); |
||
| 121 | } |
||
| 122 | |||
| 123 | 1 | if (trim($this->uri, '/') == '') { |
|
| 124 | $this->uri = '/'; |
||
| 125 | } |
||
| 126 | |||
| 127 | 1 | Hook::listen(__CLASS__); |
|
| 128 | 1 | } |
|
| 129 | |||
| 130 | /** |
||
| 131 | * Map URL to controller and action |
||
| 132 | * |
||
| 133 | * @return void |
||
| 134 | * |
||
| 135 | * @throws \Kotori\Exception\RouteNotFoundException |
||
| 136 | * @throws \Kotori\Exception\NotFoundException |
||
| 137 | */ |
||
| 138 | public function dispatch() |
||
| 139 | { |
||
| 140 | if (strtolower(Container::get('config')->get('url_mode')) == 'query_string') { |
||
| 141 | $this->uri = explode('?', $this->uri, 2); |
||
| 142 | $_SERVER['QUERY_STRING'] = isset($this->uri[1]) ? $this->uri[1] : ''; |
||
| 143 | $this->uri = $this->uri[0]; |
||
| 144 | parse_str($_SERVER['QUERY_STRING'], $_GET); |
||
| 145 | } |
||
| 146 | |||
| 147 | if ($this->uri == 'favicon.ico') { |
||
| 148 | return Container::get('response')->setStatus(404); |
||
| 149 | } |
||
| 150 | |||
| 151 | Middleware::register('before_route'); |
||
| 152 | $parsedRoute = $this->parseRoutes($this->uri); |
||
| 153 | Middleware::register('after_route'); |
||
| 154 | |||
| 155 | if ($parsedRoute) { |
||
| 156 | $this->uri = $parsedRoute; |
||
| 157 | } else { |
||
| 158 | if (Container::get('request')->isOptions()) { |
||
| 159 | Container::get('response')->setStatus(204); |
||
| 160 | exit; |
||
| 161 | } |
||
| 162 | |||
| 163 | throw new RouteNotFoundException('Request URI ' . $this->uri . ' is not Matched by any route.'); |
||
| 164 | } |
||
| 165 | |||
| 166 | $this->uris = ($this->uri != '') ? explode('/', trim($this->uri, '/')) : []; |
||
| 167 | |||
| 168 | // Clean uris |
||
| 169 | foreach ($this->uris as $key => $value) { |
||
| 170 | if ($value == '') { |
||
| 171 | unset($this->uris[$key]); |
||
| 172 | } |
||
| 173 | } |
||
| 174 | |||
| 175 | $this->uris = array_merge($this->uris); |
||
| 176 | |||
| 177 | $this->controller = $this->getController(); |
||
| 178 | $this->action = $this->getAction(); |
||
| 179 | |||
| 180 | // If is already initialized |
||
| 181 | $prefix = Container::get('config')->get('namespace_prefix'); |
||
| 182 | |||
| 183 | $controllerClassName = $prefix . 'controllers\\' . $this->controller; |
||
| 184 | |||
| 185 | Middleware::register('before_controller'); |
||
| 186 | |||
| 187 | if (isset($this->controllers[$this->controller])) { |
||
| 188 | $class = $this->controllers[$this->controller]; |
||
| 189 | } else { |
||
| 190 | $constructInstances = $this->getMethodInstances($controllerClassName); |
||
| 191 | if (!$constructInstances) { |
||
| 192 | $class = new $controllerClassName(); |
||
| 193 | } else { |
||
| 194 | $reflect = new ReflectionClass($controllerClassName); |
||
| 195 | $class = $reflect->newInstanceArgs($constructInstances); |
||
| 196 | } |
||
| 197 | |||
| 198 | $this->controllers[$this->controller] = $class; |
||
| 199 | } |
||
| 200 | |||
| 201 | Middleware::register('after_controller'); |
||
| 202 | |||
| 203 | if (!class_exists($controllerClassName)) { |
||
| 204 | throw new NotFoundException('Request Controller ' . $this->controller . ' is not Found.'); |
||
| 205 | } |
||
| 206 | |||
| 207 | if (!method_exists($class, $this->action)) { |
||
| 208 | throw new NotFoundException('Request Action ' . $this->action . ' is not Found.'); |
||
| 209 | } |
||
| 210 | |||
| 211 | $callback = [$class, $this->action]; |
||
| 212 | if (!is_callable($callback)) { |
||
| 213 | throw new NotFoundException($controllerClassName . '::' . $this->action . '() is not callable'); |
||
| 214 | } |
||
| 215 | |||
| 216 | // Parse params from uri |
||
| 217 | $this->params = $this->getParams(); |
||
| 218 | |||
| 219 | // Do some final cleaning of the params |
||
| 220 | $_GET = array_merge($this->params, $_GET); |
||
| 221 | $_REQUEST = array_merge($_POST, $_GET, $_COOKIE); |
||
| 222 | |||
| 223 | if (Container::get('config')->get('app_debug')) { |
||
| 224 | Container::get('response')->setHeader('X-Kotori-Hash', call_user_func(function () { |
||
| 225 | $lockFile = Helper::getComposerVendorPath() . '/../composer.lock'; |
||
| 226 | if (!Helper::isFile($lockFile)) { |
||
| 227 | return 'unknown'; |
||
| 228 | } else { |
||
| 229 | $lockData = file_get_contents($lockFile); |
||
| 230 | $lockData = json_decode($lockData, true); |
||
| 231 | foreach ($lockData['packages'] as $package) { |
||
| 232 | if ($package['name'] == 'kokororin/kotori-php') { |
||
| 233 | return substr($package['source']['reference'], 0, 6); |
||
| 234 | } |
||
| 235 | } |
||
| 236 | } |
||
| 237 | |||
| 238 | return 'unknown'; |
||
| 239 | })); |
||
| 240 | } |
||
| 241 | |||
| 242 | Middleware::register('before_action'); |
||
| 243 | // Call the requested method |
||
| 244 | |||
| 245 | $methodInstances = $this->getMethodInstances($callback[0], $callback[1]); |
||
| 246 | if (!$methodInstances) { |
||
| 247 | $output = call_user_func_array($callback, $this->params); |
||
| 248 | } else { |
||
| 249 | $output = call_user_func_array($callback, $methodInstances); |
||
| 250 | } |
||
| 251 | |||
| 252 | Middleware::register('after_action'); |
||
| 253 | if (is_array($output)) { |
||
| 254 | Container::get('response')->throwJSON($output); |
||
| 255 | } |
||
| 256 | } |
||
| 257 | |||
| 258 | /** |
||
| 259 | * Returns the controller name |
||
| 260 | * |
||
| 261 | * @return string |
||
| 262 | * |
||
| 263 | * @throws \Kotori\Exception\NotFoundException |
||
| 264 | */ |
||
| 265 | View Code Duplication | public function getController() |
|
| 266 | { |
||
| 267 | if (isset($this->uris[0]) && '' !== $this->uris[0]) { |
||
| 268 | $_controller = $this->uris[0]; |
||
| 269 | } else { |
||
| 270 | throw new NotFoundException('Cannot dispatch controller name.'); |
||
| 271 | } |
||
| 272 | |||
| 273 | return strip_tags($_controller); |
||
| 274 | } |
||
| 275 | |||
| 276 | /** |
||
| 277 | * Returns the action name |
||
| 278 | * |
||
| 279 | * @return string |
||
| 280 | * |
||
| 281 | * @throws \Kotori\Exception\NotFoundException |
||
| 282 | */ |
||
| 283 | View Code Duplication | public function getAction() |
|
| 284 | { |
||
| 285 | if (isset($this->uris[1])) { |
||
| 286 | $_action = $this->uris[1]; |
||
| 287 | } else { |
||
| 288 | throw new NotFoundException('Cannot dispatch action name.'); |
||
| 289 | } |
||
| 290 | |||
| 291 | return strip_tags($_action); |
||
| 292 | } |
||
| 293 | |||
| 294 | /** |
||
| 295 | * Returns the request params |
||
| 296 | * |
||
| 297 | * @return array |
||
| 298 | */ |
||
| 299 | public function getParams() |
||
| 300 | { |
||
| 301 | $params = $this->uris; |
||
| 302 | unset($params[0], $params[1]); |
||
| 303 | return array_merge($params); |
||
| 304 | } |
||
| 305 | |||
| 306 | /** |
||
| 307 | * Returns the request params instances |
||
| 308 | * |
||
| 309 | * @param mixed $class |
||
| 310 | * @param string $methodName |
||
| 311 | * @return mixed |
||
| 312 | * |
||
| 313 | * @throws \Kotori\Exception\NotFoundException |
||
| 314 | */ |
||
| 315 | private function getMethodInstances($class, $methodName = '__construct') |
||
| 316 | { |
||
| 317 | if (is_object($class)) { |
||
| 318 | $reflectClass = new ReflectionClass(get_class($class)); |
||
| 319 | } else { |
||
| 320 | $reflectClass = new ReflectionClass($class); |
||
| 321 | } |
||
| 322 | |||
| 323 | $instances = []; |
||
| 324 | $hasDI = false; |
||
| 325 | |||
| 326 | if ($reflectClass->hasMethod($methodName)) { |
||
| 327 | $reflectMethod = $reflectClass->getMethod($methodName); |
||
| 328 | |||
| 329 | $params = $reflectMethod->getParameters(); |
||
| 330 | |||
| 331 | if (count($params) > 0) { |
||
| 332 | foreach ($params as $param) { |
||
| 333 | $paramClass = $param->getClass(); |
||
| 334 | if ($paramClass) { |
||
| 335 | $paramClassName = $paramClass->getName(); |
||
| 336 | array_push($instances, Container::getByClassName($paramClassName)); |
||
| 337 | $hasDI = true; |
||
| 338 | } elseif ($hasDI) { |
||
| 339 | throw new NotFoundException('Dependency Injection cannot work with normal params'); |
||
| 340 | } |
||
| 341 | } |
||
| 342 | } |
||
| 343 | } |
||
| 344 | |||
| 345 | if ($hasDI) { |
||
| 346 | return $instances; |
||
| 347 | } |
||
| 348 | |||
| 349 | return false; |
||
| 350 | } |
||
| 351 | |||
| 352 | /** |
||
| 353 | * Returns the URI |
||
| 354 | * |
||
| 355 | * @return string |
||
| 356 | */ |
||
| 357 | public function getUri() |
||
| 358 | { |
||
| 359 | return $this->uri; |
||
| 360 | } |
||
| 361 | |||
| 362 | /** |
||
| 363 | * Returns routes |
||
| 364 | * |
||
| 365 | * @return array |
||
| 366 | */ |
||
| 367 | public function getRoutes() |
||
| 368 | { |
||
| 369 | return $this->routes; |
||
| 370 | } |
||
| 371 | |||
| 372 | /** |
||
| 373 | * Parse Routes |
||
| 374 | * |
||
| 375 | * Matches any routes that may exist in URL_ROUTE array |
||
| 376 | * against the URI to determine if the class/method need to be remapped. |
||
| 377 | * |
||
| 378 | * @param string $uri |
||
| 379 | * @return string |
||
| 380 | */ |
||
| 381 | protected function parseRoutes($uri) |
||
| 382 | { |
||
| 383 | if (Container::get('config')->get('url_route_annotation')) { |
||
| 384 | $finder = new Finder(); |
||
| 385 | $finder |
||
| 386 | ->in(Container::get('config')->get('app_full_path') . '/controllers') |
||
| 387 | ->name('*.php'); |
||
| 388 | $controllerNamespaces = []; |
||
| 389 | foreach ($finder as $file) { |
||
| 390 | array_push($controllerNamespaces, '\\' . Container::get('config')->get('namespace_prefix') . 'controllers\\' . $file->getBasename('.' . $file->getExtension())); |
||
| 391 | } |
||
| 392 | |||
| 393 | foreach ($controllerNamespaces as $namespace) { |
||
| 394 | $classReflector = new ReflectionClass($namespace); |
||
| 395 | $classAnnotations = new Annotations($classReflector); |
||
| 396 | |||
| 397 | foreach ($classReflector->getMethods() as $methodReflector) { |
||
| 398 | $methodAnnotations = new Annotations($methodReflector); |
||
| 399 | if (!isset($methodAnnotations['route'])) { |
||
| 400 | continue; |
||
| 401 | } else { |
||
| 402 | $routeAnnotations = $methodAnnotations['route']; |
||
| 403 | if (!isset($routeAnnotations['uri'])) { |
||
| 404 | throw new ConfigException('Route annotations error'); |
||
| 405 | } |
||
| 406 | |||
| 407 | $controllerName = $classReflector->getShortName(); |
||
| 408 | $actionName = $methodReflector->getName(); |
||
| 409 | $route = $controllerName . '/' . $actionName; |
||
| 410 | if (isset($routeAnnotations['params'])) { |
||
| 411 | $route .= '/' . $routeAnnotations['params']; |
||
| 412 | } |
||
| 413 | |||
| 414 | if (!isset($routeAnnotations['method'])) { |
||
| 415 | $this->routes[$routeAnnotations['uri']] = $route; |
||
| 416 | } else { |
||
| 417 | $this->routes[$routeAnnotations['uri']][$routeAnnotations['method']] = $route; |
||
| 418 | } |
||
| 419 | |||
| 420 | unset($route); |
||
| 421 | } |
||
| 422 | } |
||
| 423 | } |
||
| 424 | } else { |
||
| 425 | $this->routes = Container::get('config')->get('url_route'); |
||
| 426 | } |
||
| 427 | |||
| 428 | $hostName = Container::get('request')->getHostName(); |
||
| 429 | |||
| 430 | if (isset($this->routes[$hostName])) { |
||
| 431 | $this->routes = $this->routes[$hostName]; |
||
| 432 | } |
||
| 433 | |||
| 434 | // Get HTTP verb |
||
| 435 | $httpVerb = isset($_SERVER['REQUEST_METHOD']) ? strtolower($_SERVER['REQUEST_METHOD']) : 'cli'; |
||
| 436 | |||
| 437 | if (null != $this->routes) { |
||
| 438 | foreach ($this->routes as $key => $val) { |
||
| 439 | // Check if route format is using HTTP verbs |
||
| 440 | if (is_array($val)) { |
||
| 441 | $val = array_change_key_case($val, CASE_LOWER); |
||
| 442 | if (isset($val[$httpVerb])) { |
||
| 443 | $val = $val[$httpVerb]; |
||
| 444 | } else { |
||
| 445 | continue; |
||
| 446 | } |
||
| 447 | } |
||
| 448 | |||
| 449 | // Does the RegEx match? |
||
| 450 | if (preg_match('#^' . $key . '$#', $uri, $matches)) { |
||
| 451 | // Are we using callbacks to process back-references? |
||
| 452 | if (!is_string($val) && is_callable($val)) { |
||
| 453 | // Remove the original string from the matches array. |
||
| 454 | array_shift($matches); |
||
| 455 | |||
| 456 | // Execute the callback using the values in matches as its parameters. |
||
| 457 | $val = call_user_func_array($val, $matches); |
||
| 458 | } // Are we using the default routing method for back-references? |
||
| 459 | elseif (strpos($val, '$') !== false && strpos($key, '(') !== false) { |
||
| 460 | $val = preg_replace('#^' . $key . '$#', $val, $uri); |
||
| 461 | } |
||
| 462 | |||
| 463 | return $val; |
||
| 464 | } |
||
| 465 | } |
||
| 466 | } |
||
| 467 | } |
||
| 468 | |||
| 469 | /** |
||
| 470 | * Parse CLI arguments |
||
| 471 | * |
||
| 472 | * Take each command line argument and assume it is a URI segment. |
||
| 473 | * |
||
| 474 | * @return string |
||
| 475 | */ |
||
| 476 | 1 | protected function parseArgv() |
|
| 481 | |||
| 482 | /** |
||
| 483 | * Build Full URL |
||
| 484 | * |
||
| 485 | * @param string $uri |
||
| 486 | * @param string $module |
||
| 487 | * @return string |
||
| 488 | * |
||
| 489 | * @throws \Kotori\Exception\ConfigException |
||
| 490 | */ |
||
| 491 | public function url($uri = '', $module = null) |
||
| 520 | } |
||
| 521 |
Loading history...
Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: