KSST /
KF
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. 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 Router, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 50 | class Router implements RouterInterface, \ArrayAccess |
||
| 51 | { |
||
| 52 | /** |
||
| 53 | * @var object Koch\Config |
||
| 54 | */ |
||
| 55 | private $config; |
||
| 56 | |||
| 57 | /** |
||
| 58 | * Whether to use caching for routes or not. |
||
| 59 | * |
||
| 60 | * @var bool |
||
| 61 | */ |
||
| 62 | private static $useCache = false; |
||
| 63 | |||
| 64 | /** |
||
| 65 | * The Request URI (came in from the HttpRequest object). |
||
| 66 | * |
||
| 67 | * @var string |
||
| 68 | */ |
||
| 69 | private $uri = ''; |
||
| 70 | |||
| 71 | /** |
||
| 72 | * The Request URI as an array. |
||
| 73 | * |
||
| 74 | * @var array |
||
| 75 | */ |
||
| 76 | public $uriSegments = []; |
||
| 77 | |||
| 78 | /** |
||
| 79 | * The "extension" on the URI |
||
| 80 | * Would be "html" for the URI "/news/show/1.html". |
||
| 81 | * |
||
| 82 | * @var string |
||
| 83 | */ |
||
| 84 | private static $extension = ''; |
||
| 85 | |||
| 86 | /** |
||
| 87 | * Routes Mapping Table. |
||
| 88 | * Is an array containing several route definitions. |
||
| 89 | * |
||
| 90 | * @var array Routes Array |
||
| 91 | */ |
||
| 92 | private $routes = []; |
||
| 93 | |||
| 94 | /** |
||
| 95 | * Constructor. |
||
| 96 | */ |
||
| 97 | public function __construct(HttpRequestInterface $request) |
||
| 98 | { |
||
| 99 | $this->request = $request; |
||
|
|
|||
| 100 | |||
| 101 | // get URI from request, clean it and set it as a class property |
||
| 102 | $this->uri = self::prepareRequestURI($request->getRequestURI()); |
||
| 103 | } |
||
| 104 | |||
| 105 | /** |
||
| 106 | * Get and prepare the SERVER_URL/URI. |
||
| 107 | * |
||
| 108 | * Several fixes are applied to the $request_uri. |
||
| 109 | * |
||
| 110 | * When incomming via \Koch\Http\HttpRequest::getRequestURI() |
||
| 111 | * the $request_rui is already |
||
| 112 | * (1) lowercased and |
||
| 113 | * (2) urldecoded. |
||
| 114 | * |
||
| 115 | * This function |
||
| 116 | * (3) strips slashes from the beginning and the end, |
||
| 117 | * (4) prepends a slash and |
||
| 118 | * (5) strips PHP_SELF from the uri string. |
||
| 119 | * |
||
| 120 | * A multislash removal is not needed, because of the later usage of preg_split(). |
||
| 121 | * |
||
| 122 | * @return string Request URL |
||
| 123 | */ |
||
| 124 | public function prepareRequestURI($uri) |
||
| 125 | { |
||
| 126 | // remove xdebug_session_start parameter from uri |
||
| 127 | if (function_exists('xdebug_break')) { |
||
| 128 | $uri = str_replace('xdebug_session_start=netbeans-xdebug', '', $uri); |
||
| 129 | // remove trailing '?' or '&' |
||
| 130 | $uri = rtrim($uri, '?&'); |
||
| 131 | } |
||
| 132 | |||
| 133 | // add slash in front + remove slash at the end |
||
| 134 | if ($uri !== '/') { |
||
| 135 | $uri = '/' . trim($uri, '/'); |
||
| 136 | } |
||
| 137 | |||
| 138 | $this->uri = $uri; |
||
| 139 | |||
| 140 | return $uri; |
||
| 141 | } |
||
| 142 | |||
| 143 | /** |
||
| 144 | * Adds a route. |
||
| 145 | * |
||
| 146 | * @param string $url_pattern A route string. |
||
| 147 | * @param array $requirements Routing options. |
||
| 148 | */ |
||
| 149 | public function addRoute($url_pattern, array $requirements = null) |
||
| 150 | { |
||
| 151 | /* |
||
| 152 | * 1) Preprocess the route |
||
| 153 | */ |
||
| 154 | |||
| 155 | $url_pattern = ltrim($url_pattern, '/'); |
||
| 156 | |||
| 157 | /* |
||
| 158 | * Replace all static placeholders, like (:num) || (:id) |
||
| 159 | * with their equivalent regular expression ([0-9]+). |
||
| 160 | * |
||
| 161 | * All static placeholders not having a regexp equivalent, |
||
| 162 | * will remain on the route, like ":news". |
||
| 163 | * They will be handled as "static named" routes and route directly to |
||
| 164 | * a controller with the same name! |
||
| 165 | */ |
||
| 166 | if (strpos($url_pattern, '(') !== false) { |
||
| 167 | $url_pattern = self::placeholdersToRegexp($url_pattern); |
||
| 168 | } |
||
| 169 | |||
| 170 | // explode the uri pattern to get uri segments |
||
| 171 | $segments = explode('/', $url_pattern); |
||
| 172 | |||
| 173 | // combines all regexp patterns of segements to one regexp pattern for the route |
||
| 174 | $regexp = $this->processSegmentsRegExp($segments, $requirements); |
||
| 175 | |||
| 176 | $options = [ |
||
| 177 | 'regexp' => $regexp, |
||
| 178 | 'number_of_segments' => count($segments), |
||
| 179 | 'requirements' => $requirements, |
||
| 180 | ]; |
||
| 181 | |||
| 182 | /* |
||
| 183 | * 2) Finally add the now *preprocessed* Route. |
||
| 184 | */ |
||
| 185 | $this->routes['/' . $url_pattern] = $options; |
||
| 186 | } |
||
| 187 | |||
| 188 | /** |
||
| 189 | * Returns a regexp pattern for the route |
||
| 190 | * by combining the regexp patterns of all uri segments. |
||
| 191 | * |
||
| 192 | * It's basically string concatenation of regexp strings. |
||
| 193 | * |
||
| 194 | * @param array $segments Array with URI segments. |
||
| 195 | * @param array $requirements Array with |
||
| 196 | * |
||
| 197 | * @return string Regular Expression for the route. |
||
| 198 | */ |
||
| 199 | public function processSegmentsRegExp(array $segments, array $requirements = null) |
||
| 200 | { |
||
| 201 | // start regular expression |
||
| 202 | $regexp = '#'; |
||
| 203 | |||
| 204 | // process all segments |
||
| 205 | foreach ($segments as $segment) { |
||
| 206 | |||
| 207 | /* |
||
| 208 | * Process "Static Named Parameters". |
||
| 209 | * |
||
| 210 | * Static named parameters starts with a ":". |
||
| 211 | * Example: ":contoller". |
||
| 212 | */ |
||
| 213 | if (strpos($segment, ':') !== false) { |
||
| 214 | $name = substr($segment, 1); // remove : |
||
| 215 | |||
| 216 | // is there a requirement for this param? 'id' => '([0-9])' |
||
| 217 | if (isset($requirements[$name])) { |
||
| 218 | // add it to the regex |
||
| 219 | $regexp .= '(?P<' . $name . '>' . $requirements[$name] . ')'; |
||
| 220 | // and remove the now processed requirement |
||
| 221 | unset($requirements[$name]); |
||
| 222 | } else { // no requirement |
||
| 223 | $regexp .= '(?P<' . $name . '>[a-z_-]+)'; |
||
| 224 | } |
||
| 225 | } else { |
||
| 226 | /* |
||
| 227 | * Process "Static Parameter". |
||
| 228 | * |
||
| 229 | * Static parameters starts with a "/". |
||
| 230 | * Example: "/index" or "/news". |
||
| 231 | */ |
||
| 232 | $regexp .= '\\/' . $segment; |
||
| 233 | } |
||
| 234 | |||
| 235 | // regexp between segments (regexp combiner) |
||
| 236 | $regexp .= '\/?'; |
||
| 237 | } |
||
| 238 | |||
| 239 | // finish regular expression |
||
| 240 | $regexp .= '#'; |
||
| 241 | |||
| 242 | return $regexp; |
||
| 243 | } |
||
| 244 | |||
| 245 | /** |
||
| 246 | * Add multiple route. |
||
| 247 | * |
||
| 248 | * @param array $routes Array with multiple routes. |
||
| 249 | */ |
||
| 250 | public function addRoutes(array $routes) |
||
| 251 | { |
||
| 252 | foreach ($routes as $route => $options) { |
||
| 253 | $this->addRoute((string) $route, (array) $options); |
||
| 254 | } |
||
| 255 | } |
||
| 256 | |||
| 257 | /** |
||
| 258 | * Method returns all loaded routes. |
||
| 259 | * |
||
| 260 | * @return array Returns array with all loaded Routes. |
||
| 261 | */ |
||
| 262 | public function getRoutes() |
||
| 263 | { |
||
| 264 | return $this->routes; |
||
| 265 | } |
||
| 266 | |||
| 267 | /** |
||
| 268 | * Delete a route by its url pattern. |
||
| 269 | * |
||
| 270 | * @param string $url_pattern |
||
| 271 | */ |
||
| 272 | public function delRoute($url_pattern) |
||
| 273 | { |
||
| 274 | unset($this->routes[$url_pattern]); |
||
| 275 | } |
||
| 276 | |||
| 277 | /** |
||
| 278 | * Resets the routes array. |
||
| 279 | * |
||
| 280 | * @param bool Load the default routes. Defaults to false. |
||
| 281 | * |
||
| 282 | * @return Router \Koch\Router\Router |
||
| 283 | */ |
||
| 284 | public function reset($loadDefaultRoutes = false) |
||
| 285 | { |
||
| 286 | $this->routes = []; |
||
| 287 | |||
| 288 | TargetRoute::reset(); |
||
| 289 | |||
| 290 | if ($loadDefaultRoutes === true) { |
||
| 291 | $this->loadDefaultRoutes(); |
||
| 292 | } |
||
| 293 | |||
| 294 | return $this; |
||
| 295 | } |
||
| 296 | |||
| 297 | /** |
||
| 298 | * Generates a URL by parameters. |
||
| 299 | * |
||
| 300 | * @param string $url_pattern The URL Pattern of the route |
||
| 301 | * @param array $params An array of parameters |
||
| 302 | * @param bool $absolute Whether to generate an absolute URL |
||
| 303 | * |
||
| 304 | * @return string The generated (relative or absolute) URL. |
||
| 305 | */ |
||
| 306 | public function generateURL($url_pattern, array $params = null, $absolute = false) |
||
| 307 | { |
||
| 308 | $url = ''; |
||
| 309 | |||
| 310 | // @todo merge with buildURL + routing rules + parameters |
||
| 311 | |||
| 312 | $url_pattern = $url_pattern; |
||
| 313 | |||
| 314 | $params = $params; |
||
| 315 | |||
| 316 | if ($absolute) { |
||
| 317 | } else { |
||
| 318 | } |
||
| 319 | |||
| 320 | return $url; |
||
| 321 | } |
||
| 322 | |||
| 323 | /** |
||
| 324 | * Builds a url string. |
||
| 325 | * |
||
| 326 | * @param $url Array or String to build the url from (e.g. '/news/admin/show') |
||
| 327 | * @param $encode bool True (default) encodes the "&" in the url (amp). |
||
| 328 | */ |
||
| 329 | public static function buildURL($url, $encode = true) |
||
| 330 | { |
||
| 331 | // if urlstring is array, then a relation (urlstring => parameter_order) is given |
||
| 332 | if (is_array($url)) { |
||
| 333 | $parameterOrder = ''; |
||
| 334 | list($url, $parameterOrder) = each($url); |
||
| 335 | } |
||
| 336 | |||
| 337 | // return, if urlstring is already a qualified url (http://...) |
||
| 338 | if (false !== strpos($url, WWW_ROOT . 'index.php?')) { |
||
| 339 | return $url; |
||
| 340 | } |
||
| 341 | |||
| 342 | // only the http prefix is missing |
||
| 343 | if (false !== strpos($url, 'index.php?')) { |
||
| 344 | return 'http://' . $url; |
||
| 345 | } |
||
| 346 | |||
| 347 | // cleanup: remove all double slashes |
||
| 348 | while (false !== strpos($url, '//')) { |
||
| 349 | $url = str_replace('//', '/', $url); |
||
| 350 | } |
||
| 351 | |||
| 352 | // cleanup: remove space and slashes from begin and end of string |
||
| 353 | $url = trim($url, ' /'); |
||
| 354 | |||
| 355 | /* |
||
| 356 | * Mod_Rewrite is ON. |
||
| 357 | * |
||
| 358 | * The requested url style is: |
||
| 359 | * ROOT/news/2 |
||
| 360 | */ |
||
| 361 | if (self::isRewriteEngineOn() === true) { /* self::checkEnvForModRewrite() */ |
||
| 362 | |||
| 363 | return WWW_ROOT . ltrim($url, '/'); |
||
| 364 | } else { |
||
| 365 | /* |
||
| 366 | * Mod_Rewrite is OFF. |
||
| 367 | * |
||
| 368 | * The requested url style is: |
||
| 369 | * ROOT/index.php?mod=new&ctrl=admin&action=show&id=2 |
||
| 370 | */ |
||
| 371 | |||
| 372 | // get only the part after "index.php?" |
||
| 373 | if (false !== strpos($url, 'index.php?')) { |
||
| 374 | $url = strstr($url, 'index.php?'); |
||
| 375 | } |
||
| 376 | |||
| 377 | // $urlstring contains something like "/news/show/2" |
||
| 378 | // explode the string into an indexed array |
||
| 379 | $urlParameters = explode('/', $url); |
||
| 380 | |||
| 381 | // do we have a parameter_order given? |
||
| 382 | if (isset($parameterOrder)) { |
||
| 383 | // replace parameter names with shorthands used in the url |
||
| 384 | $search = ['module', 'controller', 'action']; |
||
| 385 | $replace = ['mod', 'ctrl', 'action']; |
||
| 386 | $parameterOrder = str_replace($search, $replace, $parameterOrder); |
||
| 387 | |||
| 388 | $urlKeys = explode('/', $parameterOrder); |
||
| 389 | } else { |
||
| 390 | // default static whitelist for url parameter keys |
||
| 391 | $urlKeys = ['mod', 'ctrl', 'action', 'id', 'type']; |
||
| 392 | } |
||
| 393 | |||
| 394 | /* |
||
| 395 | * This turns the indexed url parameters array into a named one. |
||
| 396 | * [0]=> "news" to [mod] => "news" |
||
| 397 | * [1]=> "show" to [action] => "show" |
||
| 398 | * [2]=> "2" to [id] => "2" |
||
| 399 | */ |
||
| 400 | $urlData = \Koch\Functions\Functions::arrayUnequalCombine($urlKeys, $urlParameters); |
||
| 401 | |||
| 402 | // determine the separator. it defaults to "&" for internal usage in html documents |
||
| 403 | $argSeparator = ($encode === true) ? '&' : '&'; |
||
| 404 | |||
| 405 | // Finally: build and return the url! |
||
| 406 | return WWW_ROOT . 'index.php?' . http_build_query($urlData, '', $argSeparator); |
||
| 407 | } |
||
| 408 | } |
||
| 409 | |||
| 410 | /** |
||
| 411 | * Main method of \Koch\Router\Router. |
||
| 412 | * |
||
| 413 | * The routing workflow is |
||
| 414 | * 1. firstly, check if ModRewrite is enabled, |
||
| 415 | * this decides upon which URL parser to use. |
||
| 416 | * 2. URL parser splits the uri into uri segments. |
||
| 417 | * 3. routes are initialized (the defaultRoute and all module routes) |
||
| 418 | * 4. try to find a route/map matching with the uri_segments |
||
| 419 | * 5. if no mapping applies, then set default values from config and fallback to a static routing |
||
| 420 | * 6. always! -> found_route -> call! |
||
| 421 | * |
||
| 422 | * @return TargetRoute|null |
||
| 423 | */ |
||
| 424 | public function route() |
||
| 425 | { |
||
| 426 | /* |
||
| 427 | * If there are no uri segments, loading routes and matching is pointless. |
||
| 428 | * Instead dispatch to the default route and return the according TargetRoute object. |
||
| 429 | */ |
||
| 430 | if (empty($this->uri) or $this->uri === '/') { |
||
| 431 | return $this->dispatchToDefaultRoute(); |
||
| 432 | } |
||
| 433 | |||
| 434 | // initialize Routes |
||
| 435 | $this->loadDefaultRoutes(); |
||
| 436 | |||
| 437 | /* |
||
| 438 | * Now match the URI against the Routes. |
||
| 439 | * The result is either a "dispatchable target route object" or "No target route found.". |
||
| 440 | */ |
||
| 441 | $targetRoute = $this->match(); |
||
| 442 | |||
| 443 | /* |
||
| 444 | * Inject the target route object back to the request. |
||
| 445 | * Thereby the request gains full knowledge about the URL mapping (external to internal). |
||
| 446 | * We might ask the request object later, where the requests maps to. |
||
| 447 | */ |
||
| 448 | $this->request->setRoute($targetRoute); |
||
| 449 | |||
| 450 | return $targetRoute; |
||
| 451 | } |
||
| 452 | |||
| 453 | public function dispatchToDefaultRoute() |
||
| 454 | { |
||
| 455 | $targetRoute = TargetRoute::instantiate(); |
||
| 456 | // was the default route configured correctly |
||
| 457 | // @todo this is only possible if set from config to target route |
||
| 458 | //if ($targetRoute::dispatchable()) { |
||
| 459 | // default route is dispatchable, set it to the request |
||
| 460 | $this->request->setRoute($targetRoute); |
||
| 461 | |||
| 462 | return $targetRoute; |
||
| 463 | // } else { |
||
| 464 | // an undispatchable route was configured |
||
| 465 | // self::dispatchTo404(); |
||
| 466 | //} |
||
| 467 | } |
||
| 468 | |||
| 469 | public static function dispatchTo404() |
||
| 470 | { |
||
| 471 | TargetRoute::setController('error'); |
||
| 472 | TargetRoute::setAction('routenotfound'); |
||
| 473 | } |
||
| 474 | |||
| 475 | /** |
||
| 476 | * Renameds URL shorthands like "mod" to "module". |
||
| 477 | * This is needed, because routing might be noRewrite. |
||
| 478 | * So the uri segments array might contain something like "mod" => "news". |
||
| 479 | * We need this to be "module" => "news" for setting it to the TargetRoute. |
||
| 480 | * |
||
| 481 | * @param $array |
||
| 482 | * |
||
| 483 | * @return $array |
||
| 484 | */ |
||
| 485 | public static function fixNoRewriteShorthands($array) |
||
| 486 | { |
||
| 487 | if (isset($array['mod'])) { |
||
| 488 | $array['module'] = $array['mod']; |
||
| 489 | unset($array['mod']); |
||
| 490 | } |
||
| 491 | |||
| 492 | return $array; |
||
| 493 | } |
||
| 494 | |||
| 495 | /** |
||
| 496 | * Setter Method for URI. Needed for testing. |
||
| 497 | * |
||
| 498 | * @param string $uri |
||
| 499 | */ |
||
| 500 | public function setRequestURI($uri) |
||
| 501 | { |
||
| 502 | $this->uri = $uri; |
||
| 503 | } |
||
| 504 | |||
| 505 | /** |
||
| 506 | * Matches the URI against the Routes Mapping Table. |
||
| 507 | * Taking static, dynamic and regexp routings into account. |
||
| 508 | * In other words, it "map matches the URI". |
||
| 509 | * |
||
| 510 | * @return TargetRoute|null |
||
| 511 | */ |
||
| 512 | public function match() |
||
| 513 | { |
||
| 514 | // do we have some routes now? |
||
| 515 | if (0 === count($this->routes)) { |
||
| 516 | throw new \OutOfBoundsException('The routes lookup table is empty. Define some routes.'); |
||
| 517 | } |
||
| 518 | |||
| 519 | /* |
||
| 520 | * Detects if Mod_Rewrite engine is active and |
||
| 521 | * calls the proper URL Parser/Segmentizer method for the extraction of uri segments. |
||
| 522 | */ |
||
| 523 | if ($this->isRewriteEngineOn() or isset($_ENV['FORCE_MOD_REWRITE_ON']) and |
||
| 524 | true === empty($_GET['mod']) and true === empty($_GET['ctrl'])) { |
||
| 525 | $this->uriSegments = $this->parseUrlRewrite($this->uri); |
||
| 526 | } else { |
||
| 527 | $this->uriSegments = $this->parseUrlNoRewrite($this->uri); |
||
| 528 | |||
| 529 | $this->uriSegments = self::fixNoRewriteShorthands($this->uriSegments); |
||
| 530 | |||
| 531 | $targetRoute = TargetRoute::setSegmentsToTargetRoute($this->uriSegments); |
||
| 532 | |||
| 533 | if ($targetRoute::dispatchable()) { |
||
| 534 | return $targetRoute; |
||
| 535 | } |
||
| 536 | } |
||
| 537 | |||
| 538 | /* |
||
| 539 | * Reduce the map lookup table, by dropping all routes |
||
| 540 | * with more segments than the current requested uri. |
||
| 541 | */ |
||
| 542 | if (count($this->routes) > 1 and count($this->uriSegments) >= 1) { |
||
| 543 | self::reduceRoutesToSegmentCount(); |
||
| 544 | } |
||
| 545 | |||
| 546 | /* |
||
| 547 | * Process: Static Route |
||
| 548 | * |
||
| 549 | * Do we have a direct match ? |
||
| 550 | * This matches "static routes". Without any preg_match overhead. |
||
| 551 | * |
||
| 552 | * Example: |
||
| 553 | * The request URI "/news/index" relates 1:1 to $routes['/news/index']. |
||
| 554 | * The request URI "/login" relates 1:1 to $routes['/login'] |
||
| 555 | */ |
||
| 556 | if (isset($this->routes[$this->uri])) { |
||
| 557 | |||
| 558 | // we have a direct match |
||
| 559 | $found_route = $this->routes[$this->uri]; |
||
| 560 | |||
| 561 | // return the TargetRoute object |
||
| 562 | return TargetRoute::setSegmentsToTargetRoute($found_route); |
||
| 563 | } else { |
||
| 564 | |||
| 565 | /* |
||
| 566 | * No, there wasn't a 1:1 match. |
||
| 567 | * Now we have to check the uri segments. |
||
| 568 | * |
||
| 569 | * Let's loop over the remaining routes and try to map match the uri_segments. |
||
| 570 | */ |
||
| 571 | foreach ($this->routes as $route_pattern => $route_values) { |
||
| 572 | unset($route_pattern); |
||
| 573 | |||
| 574 | $matches = ''; |
||
| 575 | |||
| 576 | /** |
||
| 577 | * Process: Dynamic Regular Expression Parameters. |
||
| 578 | * |
||
| 579 | * Example: |
||
| 580 | * URI: /news |
||
| 581 | * Rule /:controller |
||
| 582 | * Regexp: "#(?P<controller>[a-z0-9_-]+)\/?#" |
||
| 583 | * Matches: $matches['controller'] = 'news'; |
||
| 584 | */ |
||
| 585 | if (1 === preg_match($route_values['regexp'], $this->uri, $matches)) { |
||
| 586 | |||
| 587 | // matches[0] contains $this->uri |
||
| 588 | unset($matches[0]); |
||
| 589 | |||
| 590 | // remove duplicate values |
||
| 591 | // e.g. [controller] = news |
||
| 592 | // [1] = news |
||
| 593 | $matches = array_unique($matches); |
||
| 594 | |||
| 595 | # @todo # fetch key and its position from $route_values['requirements'] |
||
| 596 | if (count($route_values['requirements']) > 0) { |
||
| 597 | foreach ($route_values['requirements'] as $array_position => $key_name) { |
||
| 598 | |||
| 599 | // insert a new key |
||
| 600 | // with name from requirements array |
||
| 601 | // and value from matches array |
||
| 602 | // ([id] => 42) |
||
| 603 | $pos = $array_position + 1; |
||
| 604 | $matches[$key_name] = $matches[$pos]; |
||
| 605 | |||
| 606 | // remove the old not-named key ([2] => 42) |
||
| 607 | unset($matches[$pos]); |
||
| 608 | } |
||
| 609 | } |
||
| 610 | |||
| 611 | // insert $matches[<controller>] etc |
||
| 612 | TargetRoute::setSegmentsToTargetRoute($matches); |
||
| 613 | } |
||
| 614 | |||
| 615 | if (TargetRoute::dispatchable()) { |
||
| 616 | // route found, stop foreach |
||
| 617 | break; |
||
| 618 | } else { |
||
| 619 | TargetRoute::reset(); |
||
| 620 | continue; |
||
| 621 | } |
||
| 622 | } |
||
| 623 | } |
||
| 624 | |||
| 625 | return TargetRoute::instantiate(); |
||
| 626 | } |
||
| 627 | |||
| 628 | /** |
||
| 629 | * Parses the URI and returns an array with URI segments. |
||
| 630 | * |
||
| 631 | * URL Parser for Apache Mod_Rewrite URL/URIs. |
||
| 632 | * Think of it as a ModRewrite_Request_Resolver. |
||
| 633 | * |
||
| 634 | * This is based on htaccess rewriting with [QSA,L] (Query Append String). |
||
| 635 | * |
||
| 636 | * @param string $uri |
||
| 637 | * |
||
| 638 | * @return array Array with URI segments. |
||
| 639 | */ |
||
| 640 | private static function parseUrlRewrite($uri) |
||
| 693 | |||
| 694 | /** |
||
| 695 | * Parses the URI and returns an array with URI segments. |
||
| 696 | * |
||
| 697 | * URL Parser for NoRewrite URL/URIs. |
||
| 698 | * This URLParser has to extract mod, sub, action, id/parameters from the URI. |
||
| 699 | * Alternate name: Standard_Request_Resolver. |
||
| 700 | * |
||
| 701 | * @param string $uri |
||
| 702 | * |
||
| 703 | * @return array Array with URI segments. |
||
| 704 | */ |
||
| 705 | private function parseUrlNoRewrite($uri) |
||
| 706 | { |
||
| 707 | if (false !== strpos('?', $uri)) { |
||
| 708 | return [0 => $uri]; |
||
| 709 | } |
||
| 710 | |||
| 711 | // use some parse_url magic to get the url_query part from the uri |
||
| 712 | $uri_query_string = parse_url($uri, PHP_URL_QUERY); |
||
| 713 | unset($uri); |
||
| 714 | |||
| 715 | /* |
||
| 716 | * The ampersand (&) |
||
| 717 | * |
||
| 718 | * Use ampersand as the split char for string to array conversion. |
||
| 719 | */ |
||
| 720 | $uri_query_array = explode('&', $uri_query_string); |
||
| 721 | |||
| 722 | /* |
||
| 723 | * The equals sign (=) |
||
| 724 | * |
||
| 725 | * This addresses the pair relationship between parameter name and value, like "id=77". |
||
| 726 | */ |
||
| 727 | $uri_segments = []; |
||
| 728 | |||
| 729 | if (count($uri_query_array) > 0) { |
||
| 730 | $key = ''; |
||
| 731 | $value = ''; |
||
| 732 | $query_pair = ''; |
||
| 733 | foreach ($uri_query_array as $query_pair) { |
||
| 734 | if (false !== strpos($query_pair, '=')) { |
||
| 735 | list($key, $value) = explode('=', $query_pair); |
||
| 736 | $uri_segments[$key] = $value; |
||
| 737 | } |
||
| 738 | } |
||
| 739 | unset($query_pair, $key, $value); |
||
| 740 | } |
||
| 741 | unset($uri_query_string, $uri_query_array); |
||
| 742 | |||
| 743 | // Finished! |
||
| 744 | return $uri_segments; |
||
| 745 | } |
||
| 746 | |||
| 747 | /** |
||
| 748 | * Check if Apache "mod_rewrite" is activated in configuration. |
||
| 749 | * |
||
| 750 | * @return bool True, if "mod_rewrite" enabled. False otherwise. |
||
| 751 | */ |
||
| 752 | public static function isRewriteEngineOn() |
||
| 753 | { |
||
| 754 | // via constant |
||
| 755 | if (defined('REWRITE_ENGINE_ON') && REWRITE_ENGINE_ON === true) { |
||
| 756 | return true; |
||
| 757 | } |
||
| 758 | |||
| 759 | // via config |
||
| 760 | /*if (isset($this->config['router']['mod_rewrite'])) { |
||
| 761 | $bool = (bool) $this->config['router']['mod_rewrite']; |
||
| 762 | define('REWRITE_ENGINE_ON', $bool); |
||
| 763 | |||
| 764 | return $bool; |
||
| 765 | }*/ |
||
| 766 | |||
| 767 | return false; # $this->checkEnvForModRewrite(); |
||
| 768 | } |
||
| 769 | |||
| 770 | /** |
||
| 771 | * Checks if Apache Module "mod_rewrite" is loaded/enabled |
||
| 772 | * and Rewrite Engine is enabled in .htaccess". |
||
| 773 | * |
||
| 774 | * @return bool True, if mod_rewrite on. |
||
| 775 | */ |
||
| 776 | public static function checkEnvForModRewrite() |
||
| 777 | { |
||
| 778 | // ensure apache has module mod_rewrite active |
||
| 779 | if (true === function_exists('apache_get_modules') and |
||
| 780 | true === in_array('mod_rewrite', apache_get_modules(), true)) { |
||
| 781 | if (true === is_file(APPLICATION_PATH . '.htaccess')) { |
||
| 782 | // load htaccess and check if RewriteEngine is enabled |
||
| 783 | $htaccess_content = file_get_contents(APPLICATION_PATH . '.htaccess'); |
||
| 784 | $rewriteEngineOn = preg_match('/.*[^#][\t ]+RewriteEngine[\t ]+On/i', $htaccess_content); |
||
| 785 | |||
| 786 | if (true === (bool) $rewriteEngineOn) { |
||
| 787 | return true; |
||
| 788 | } else { |
||
| 789 | // @todo Hint: Please enable mod_rewrite in htaccess. |
||
| 790 | return false; |
||
| 791 | } |
||
| 792 | } else { |
||
| 793 | // @todo Hint: No htaccess file found. Create and enable mod_rewrite. |
||
| 794 | return false; |
||
| 795 | } |
||
| 796 | } else { |
||
| 797 | // @todo Hint: Please enable mod_rewrite module for Apache. |
||
| 798 | return false; |
||
| 799 | } |
||
| 800 | } |
||
| 801 | |||
| 802 | /** |
||
| 803 | * Replaces the placeholders in a route, like alpha, num, word |
||
| 804 | * with their regular expressions for later preg_matching. |
||
| 805 | * This is used while adding a new Route. |
||
| 806 | * |
||
| 807 | * @param string $route_with_placeholders A Route with a placeholder like alpha or num. |
||
| 808 | */ |
||
| 809 | public static function placeholdersToRegexp($route_with_placeholders) |
||
| 810 | { |
||
| 811 | $placeholders = ['(:id)', '(:num)', '(:alpha)', '(:alphanum)', '(:any)', '(:word)', |
||
| 812 | '(:year)', '(:month)', '(:day)', ]; |
||
| 813 | |||
| 814 | $replacements = ['([0-9]+)', '([0-9]+)', '([a-zA-Z]+)', '([a-zA-Z0-9]+)', '(.*)', '(\w+)', |
||
| 815 | '([12][0-9]{3})', '(0[1-9]|1[012])', '(0[1-9]|1[012])', ]; |
||
| 816 | |||
| 817 | return str_replace($placeholders, $replacements, $route_with_placeholders); |
||
| 818 | } |
||
| 819 | |||
| 820 | /** |
||
| 821 | * This unsets all Routes of Routing Table ($this->routes) |
||
| 822 | * which have more segments then the request uri. |
||
| 823 | */ |
||
| 824 | public function reduceRoutesToSegmentCount() |
||
| 825 | { |
||
| 826 | $route_pattern = ''; |
||
| 827 | $route_values = ''; |
||
| 828 | $number_of_uri_segements = count($this->uriSegments); |
||
| 829 | |||
| 830 | foreach ($this->routes as $route_pattern => $route_values) { |
||
| 831 | if ($route_values['number_of_segments'] === $number_of_uri_segements) { |
||
| 832 | continue; |
||
| 833 | } else { |
||
| 834 | unset($this->routes[$route_pattern]); |
||
| 835 | } |
||
| 836 | } |
||
| 837 | |||
| 838 | unset($route_pattern, $route_values); |
||
| 839 | } |
||
| 840 | |||
| 841 | /** |
||
| 842 | * Register the default routes. |
||
| 843 | */ |
||
| 844 | public function loadDefaultRoutes() |
||
| 845 | { |
||
| 846 | // Is Routes Caching is enabled in config? |
||
| 847 | if (isset($this->config['router']['caching'])) { |
||
| 848 | self::$useCache = ($this->config['router']['caching'] === true) ? true : false; |
||
| 849 | } |
||
| 850 | |||
| 851 | // Load Routes from Cache |
||
| 852 | if (true === self::$useCache and true === empty($this->routes) and |
||
| 853 | Cache::contains('clansuite.routes')) { |
||
| 854 | $this->addRoutes(Cache::read('clansuite.routes')); |
||
| 855 | } |
||
| 856 | |||
| 857 | // Load Routes from Config "routes.config.php" |
||
| 858 | if (true === empty($this->routes)) { |
||
| 859 | $routes = Manager::loadRoutesFromConfig(); |
||
| 860 | if ($routes) { |
||
| 861 | $this->addRoutes($routes); |
||
| 862 | } |
||
| 863 | |||
| 864 | // and save these routes to cache |
||
| 865 | if (true === self::$useCache) { |
||
| 866 | Cache::store('clansuite.routes', $this->getRoutes()); |
||
| 867 | } |
||
| 868 | } |
||
| 869 | |||
| 870 | /* |
||
| 871 | * Connect some default fallback Routes |
||
| 872 | * |
||
| 873 | * Example for Route definition with ArrayAccess: $r['/:controller']; |
||
| 874 | */ |
||
| 875 | if (empty($this->routes)) { |
||
| 876 | # one segment |
||
| 877 | //// "/news" (list) |
||
| 878 | $this->addRoute('/:module'); |
||
| 879 | # two segments |
||
| 880 | // "/news/new" (new) |
||
| 881 | $this->addRoute('/:module/:action'); |
||
| 882 | // "/news/news" (list) |
||
| 883 | $this->addRoute('/:module/:controller'); |
||
| 884 | // "/news/31" (show/update/delete) |
||
| 885 | $this->addRoute('/:controller/(:id)', [1 => 'id']); |
||
| 886 | // "/news/news/31" (show/update/delete) |
||
| 887 | $this->addRoute('/:module/(:id)', [1 => 'id']); |
||
| 888 | # three segments |
||
| 889 | // "/news/news/new" (new) |
||
| 890 | $this->addRoute('/:module/:controller/:action'); |
||
| 891 | // "/news/edit/42" (edit) |
||
| 892 | $this->addRoute('/:controller/:action/(:id)', [2 => 'id']); |
||
| 893 | // "/news/42/edit" (edit) |
||
| 894 | $this->addRoute('/:module/(:id)/:action', [1 => 'id']); |
||
| 895 | // "/news/news/31" (show/update/delete) |
||
| 896 | $this->addRoute('/:module/:controller/(:id)', [2 => 'id']); |
||
| 897 | # four segments |
||
| 898 | // "/news/news/31/edit" (edit) |
||
| 899 | $this->addRoute('/:module/:controller/(:id)/:action', [2 => 'id']); |
||
| 900 | // "/news/news/edit/31" (edit) |
||
| 901 | $this->addRoute('/:module/:controller/:action/(:id)', [3 => 'id']); |
||
| 902 | # five segments |
||
| 903 | // "/news/news/edit/31.html" (edit) |
||
| 904 | $this->addRoute('/:module/:controller/:action/(:id)/:format', [4 => 'id']); |
||
| 905 | } |
||
| 906 | } |
||
| 907 | |||
| 908 | /** |
||
| 909 | * Implementation of SPL ArrayAccess. |
||
| 910 | */ |
||
| 911 | |||
| 912 | /** |
||
| 913 | * Instead of working with $router->addRoute(name,map); |
||
| 914 | * you may now access the routing table as an array $router[$route] = $map;. |
||
| 915 | */ |
||
| 916 | final public function offsetSet($route, $target) |
||
| 920 | |||
| 921 | final public function offsetGet($name) |
||
| 922 | { |
||
| 923 | if ((isset($this->routes[$name])) || (array_key_exists($name, $this->routes))) { |
||
| 924 | return $this->routes[$name]; |
||
| 925 | } else { |
||
| 926 | return; |
||
| 927 | } |
||
| 928 | } |
||
| 929 | |||
| 930 | final public function offsetExists($name) |
||
| 934 | |||
| 935 | final public function offsetUnset($name) |
||
| 939 | } |
||
| 940 |
Loading history...
In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:
Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: