paulgoughbooks_old
This repository has no backups
This repository's network speed is throttled to 100KB/sec
Upgrade your account to fix these warnings, or use backups.vc for automated backups
@ 2
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 |
<?php /** * CodeIgniter * * An open source application development framework for PHP * * This content is released under the MIT License (MIT) * * Copyright (c) 2014-2019 British Columbia Institute of Technology * Copyright (c) 2019-2020 CodeIgniter Foundation * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. * * @package CodeIgniter * @author CodeIgniter Dev Team * @copyright 2019-2020 CodeIgniter Foundation * @license https://opensource.org/licenses/MIT MIT License * @link https://codeigniter.com * @since Version 4.0.0 * @filesource */ namespace CodeIgniter\Router; use CodeIgniter\Autoloader\FileLocator; use CodeIgniter\HTTP\Request; use CodeIgniter\Router\Exceptions\RouterException; use Config\Services; /** * Class RouteCollection * * @todo Implement nested resource routing (See CakePHP) * * @package CodeIgniter\Router */ class RouteCollection implements RouteCollectionInterface { /** * The namespace to be added to any Controllers. * Defaults to the global namespaces (\) * * @var string */ protected $defaultNamespace = '\\'; /** * The name of the default controller to use * when no other controller is specified. * * Not used here. Pass-thru value for Router class. * * @var string */ protected $defaultController = 'Home'; /** * The name of the default method to use * when no other method has been specified. * * Not used here. Pass-thru value for Router class. * * @var string */ protected $defaultMethod = 'index'; /** * The placeholder used when routing 'resources' * when no other placeholder has been specified. * * @var string */ protected $defaultPlaceholder = 'any'; /** * Whether to convert dashes to underscores in URI. * * Not used here. Pass-thru value for Router class. * * @var boolean */ protected $translateURIDashes = false; /** * Whether to match URI against Controllers * when it doesn't match defined routes. * * Not used here. Pass-thru value for Router class. * * @var boolean */ protected $autoRoute = true; /** * A callable that will be shown * when the route cannot be matched. * * @var string|\Closure */ protected $override404; /** * Defined placeholders that can be used * within the * * @var array */ protected $placeholders = [ 'any' => '.*', 'segment' => '[^/]+', 'alphanum' => '[a-zA-Z0-9]+', 'num' => '[0-9]+', 'alpha' => '[a-zA-Z]+', 'hash' => '[^/]+', ]; /** * An array of all routes and their mappings. * * @var array */ protected $routes = [ '*' => [], 'options' => [], 'get' => [], 'head' => [], 'post' => [], 'put' => [], 'delete' => [], 'trace' => [], 'connect' => [], 'cli' => [], ]; /** * Array of routes options * * @var array */ protected $routesOptions = []; /** * The current method that the script is being called by. * * @var string */ protected $HTTPVerb; /** * The default list of HTTP methods (and CLI for command line usage) * that is allowed if no other method is provided. * * @var array */ protected $defaultHTTPMethods = [ 'options', 'get', 'head', 'post', 'put', 'delete', 'trace', 'connect', 'cli', ]; /** * The name of the current group, if any. * * @var string */ protected $group; /** * The current subdomain. * * @var string */ protected $currentSubdomain; /** * Stores copy of current options being * applied during creation. * * @var null */ protected $currentOptions; /** * A little performance booster. * * @var boolean */ protected $didDiscover = false; /** * Handle to the file locator to use. * * @var \CodeIgniter\Autoloader\FileLocator */ protected $fileLocator; /** * Handle to the modules config. * * @var \Config\Modules */ protected $moduleConfig; //-------------------------------------------------------------------- /** * Constructor * * @param \CodeIgniter\Autoloader\FileLocator $locator * @param \Config\Modules $moduleConfig */ public function __construct(FileLocator $locator, $moduleConfig) { $this->fileLocator = $locator; $this->moduleConfig = $moduleConfig; } //-------------------------------------------------------------------- /** * Registers a new constraint with the system. Constraints are used * by the routes as placeholders for regular expressions to make defining * the routes more human-friendly. * * You can pass an associative array as $placeholder, and have * multiple placeholders added at once. * * @param string|array $placeholder * @param string $pattern * * @return \CodeIgniter\Router\RouteCollectionInterface */ public function addPlaceholder($placeholder, string $pattern = null): RouteCollectionInterface { if (! is_array($placeholder)) { $placeholder = [$placeholder => $pattern]; } $this->placeholders = array_merge($this->placeholders, $placeholder); return $this; } //-------------------------------------------------------------------- /** * Sets the default namespace to use for Controllers when no other * namespace has been specified. * * @param string $value * * @return \CodeIgniter\Router\RouteCollectionInterface */ public function setDefaultNamespace(string $value): RouteCollectionInterface { $this->defaultNamespace = filter_var($value, FILTER_SANITIZE_STRING); $this->defaultNamespace = rtrim($this->defaultNamespace, '\\') . '\\'; return $this; } //-------------------------------------------------------------------- /** * Sets the default controller to use when no other controller has been * specified. * * @param string $value * * @return \CodeIgniter\Router\RouteCollectionInterface */ public function setDefaultController(string $value): RouteCollectionInterface { $this->defaultController = filter_var($value, FILTER_SANITIZE_STRING); return $this; } //-------------------------------------------------------------------- /** * Sets the default method to call on the controller when no other * method has been set in the route. * * @param string $value * * @return \CodeIgniter\Router\RouteCollectionInterface */ public function setDefaultMethod(string $value): RouteCollectionInterface { $this->defaultMethod = filter_var($value, FILTER_SANITIZE_STRING); return $this; } //-------------------------------------------------------------------- /** * Tells the system whether to convert dashes in URI strings into * underscores. In some search engines, including Google, dashes * create more meaning and make it easier for the search engine to * find words and meaning in the URI for better SEO. But it * doesn't work well with PHP method names.... * * @param boolean $value * * @return \CodeIgniter\Router\RouteCollectionInterface */ public function setTranslateURIDashes(bool $value): RouteCollectionInterface { $this->translateURIDashes = $value; return $this; } //-------------------------------------------------------------------- /** * If TRUE, the system will attempt to match the URI against * Controllers by matching each segment against folders/files * in APPPATH/Controllers, when a match wasn't found against * defined routes. * * If FALSE, will stop searching and do NO automatic routing. * * @param boolean $value * * @return RouteCollectionInterface */ public function setAutoRoute(bool $value): RouteCollectionInterface { $this->autoRoute = $value; return $this; } //-------------------------------------------------------------------- /** * Sets the class/method that should be called if routing doesn't * find a match. It can be either a closure or the controller/method * name exactly like a route is defined: Users::index * * This setting is passed to the Router class and handled there. * * @param callable|null $callable * * @return RouteCollectionInterface */ public function set404Override($callable = null): RouteCollectionInterface { $this->override404 = $callable; return $this; } //-------------------------------------------------------------------- /** * Returns the 404 Override setting, which can be null, a closure * or the controller/string. * * @return string|\Closure|null */ public function get404Override() { return $this->override404; } //-------------------------------------------------------------------- /** * Will attempt to discover any additional routes, either through * the local PSR4 namespaces, or through selected Composer packages. */ protected function discoverRoutes() { if ($this->didDiscover) { return; } // We need this var in local scope // so route files can access it. $routes = $this; if ($this->moduleConfig->shouldDiscover('routes')) { $files = $this->fileLocator->search('Config/Routes.php'); foreach ($files as $file) { // Don't include our main file again... if ($file === APPPATH . 'Config/Routes.php') { continue; } include $file; } } $this->didDiscover = true; } //-------------------------------------------------------------------- /** * Sets the default constraint to be used in the system. Typically * for use with the 'resource' method. * * @param string $placeholder * * @return RouteCollectionInterface */ public function setDefaultConstraint(string $placeholder): RouteCollectionInterface { if (array_key_exists($placeholder, $this->placeholders)) { $this->defaultPlaceholder = $placeholder; } return $this; } //-------------------------------------------------------------------- /** * Returns the name of the default controller. With Namespace. * * @return string */ public function getDefaultController(): string { return $this->defaultController; } //-------------------------------------------------------------------- /** * Returns the name of the default method to use within the controller. * * @return string */ public function getDefaultMethod(): string { return $this->defaultMethod; } //-------------------------------------------------------------------- /** * Returns the default namespace as set in the Routes config file. * * @return string */ public function getDefaultNamespace(): string { return $this->defaultNamespace; } //-------------------------------------------------------------------- /** * Returns the current value of the translateURIDashes setting. * * @return boolean */ public function shouldTranslateURIDashes(): bool { return $this->translateURIDashes; } //-------------------------------------------------------------------- /** * Returns the flag that tells whether to autoRoute URI against Controllers. * * @return boolean */ public function shouldAutoRoute(): bool { return $this->autoRoute; } //-------------------------------------------------------------------- /** * Returns the raw array of available routes. * * @param mixed $verb * * @return array */ public function getRoutes($verb = null): array { if (empty($verb)) { $verb = $this->getHTTPVerb(); } // Since this is the entry point for the Router, // take a moment to do any route discovery // we might need to do. $this->discoverRoutes(); $routes = []; if (isset($this->routes[$verb])) { // Keep current verb's routes at the beginning so they're matched // before any of the generic, "add" routes. if (isset($this->routes['*'])) { $extraRules = array_diff_key($this->routes['*'], $this->routes[$verb]); $collection = array_merge($this->routes[$verb], $extraRules); } foreach ($collection as $r) { $key = key($r['route']); $routes[$key] = $r['route'][$key]; } } return $routes; } //-------------------------------------------------------------------- /** * Returns one or all routes options * * @param string $from * * @return array */ public function getRoutesOptions(string $from = null): array { return $from ? $this->routesOptions[$from] ?? [] : $this->routesOptions; } //-------------------------------------------------------------------- /** * Returns the current HTTP Verb being used. * * @return string */ public function getHTTPVerb(): string { return $this->HTTPVerb; } //-------------------------------------------------------------------- /** * Sets the current HTTP verb. * Used primarily for testing. * * @param string $verb * * @return $this */ public function setHTTPVerb(string $verb) { $this->HTTPVerb = $verb; return $this; } /** * A shortcut method to add a number of routes at a single time. * It does not allow any options to be set on the route, or to * define the method used. * * @param array $routes * @param array $options * * @return RouteCollectionInterface */ public function map(array $routes = [], array $options = null): RouteCollectionInterface { foreach ($routes as $from => $to) { $this->add($from, $to, $options); } return $this; } //-------------------------------------------------------------------- /** * Adds a single route to the collection. * * Example: * $routes->add('news', 'Posts::index'); * * @param string $from * @param array|string $to * @param array|null $options * * @return RouteCollectionInterface */ public function add(string $from, $to, array $options = null): RouteCollectionInterface { $this->create('*', $from, $to, $options); return $this; } //-------------------------------------------------------------------- /** * Adds a temporary redirect from one route to another. Used for * redirecting traffic from old, non-existing routes to the new * moved routes. * * @param string $from The pattern to match against * @param string $to Either a route name or a URI to redirect to * @param integer $status The HTTP status code that should be returned with this redirect * * @return RouteCollection */ public function addRedirect(string $from, string $to, int $status = 302) { // Use the named route's pattern if this is a named route. if (array_key_exists($to, $this->routes['*'])) { $to = $this->routes['*'][$to]['route']; } elseif (array_key_exists($to, $this->routes['get'])) { $to = $this->routes['get'][$to]['route']; } $this->create('*', $from, $to, ['redirect' => $status]); return $this; } //-------------------------------------------------------------------- /** * Determines if the route is a redirecting route. * * @param string $from * * @return boolean */ public function isRedirect(string $from): bool { foreach ($this->routes['*'] as $name => $route) { // Named route? if ($name === $from || key($route['route']) === $from) { return isset($route['redirect']) && is_numeric($route['redirect']); } } return false; } //-------------------------------------------------------------------- /** * Grabs the HTTP status code from a redirecting Route. * * @param string $from * * @return integer */ public function getRedirectCode(string $from): int { foreach ($this->routes['*'] as $name => $route) { // Named route? if ($name === $from || key($route['route']) === $from) { return $route['redirect'] ?? 0; } } return 0; } //-------------------------------------------------------------------- //-------------------------------------------------------------------- // Grouping Routes //-------------------------------------------------------------------- /** * Group a series of routes under a single URL segment. This is handy * for grouping items into an admin area, like: * * Example: * // Creates route: admin/users * $route->group('admin', function() { * $route->resource('users'); * }); * * @param string $name The name to group/prefix the routes with. * @param array ...$params * * @return void */ public function group(string $name, ...$params) { $oldGroup = $this->group; $oldOptions = $this->currentOptions; // To register a route, we'll set a flag so that our router // so it will see the group name. $this->group = ltrim($oldGroup . '/' . $name, '/'); $callback = array_pop($params); if ($params && is_array($params[0])) { $this->currentOptions = array_shift($params); } if (is_callable($callback)) { $callback($this); } $this->group = $oldGroup; $this->currentOptions = $oldOptions; } //-------------------------------------------------------------------- //-------------------------------------------------------------------- // HTTP Verb-based routing //-------------------------------------------------------------------- // Routing works here because, as the routes Config file is read in, // the various HTTP verb-based routes will only be added to the in-memory // routes if it is a call that should respond to that verb. // // The options array is typically used to pass in an 'as' or var, but may // be expanded in the future. See the docblock for 'add' method above for // current list of globally available options. // /** * Creates a collections of HTTP-verb based routes for a controller. * * Possible Options: * 'controller' - Customize the name of the controller used in the 'to' route * 'placeholder' - The regex used by the Router. Defaults to '(:any)' * 'websafe' - - '1' if only GET and POST HTTP verbs are supported * * Example: * * $route->resource('photos'); * * // Generates the following routes: * HTTP Verb | Path | Action | Used for... * ----------+-------------+---------------+----------------- * GET /photos index an array of photo objects * GET /photos/new new an empty photo object, with default properties * GET /photos/{id}/edit edit a specific photo object, editable properties * GET /photos/{id} show a specific photo object, all properties * POST /photos create a new photo object, to add to the resource * DELETE /photos/{id} delete deletes the specified photo object * PUT/PATCH /photos/{id} update replacement properties for existing photo * * If 'websafe' option is present, the following paths are also available: * * POST /photos/{id}/delete delete * POST /photos/{id} update * * @param string $name The name of the resource/controller to route to. * @param array|null $options An list of possible ways to customize the routing. * * @return RouteCollectionInterface */ public function resource(string $name, array $options = null): RouteCollectionInterface { // In order to allow customization of the route the // resources are sent to, we need to have a new name // to store the values in. $new_name = ucfirst($name); // If a new controller is specified, then we replace the // $name value with the name of the new controller. if (isset($options['controller'])) { $new_name = ucfirst(filter_var($options['controller'], FILTER_SANITIZE_STRING)); } // In order to allow customization of allowed id values // we need someplace to store them. $id = $this->placeholders[$this->defaultPlaceholder] ?? '(:segment)'; if (isset($options['placeholder'])) { $id = $options['placeholder']; } // Make sure we capture back-references $id = '(' . trim($id, '()') . ')'; $methods = isset($options['only']) ? (is_string($options['only']) ? explode(',', $options['only']) : $options['only']) : ['index', 'show', 'create', 'update', 'delete', 'new', 'edit']; if (isset($options['except'])) { $options['except'] = is_array($options['except']) ? $options['except'] : explode(',', $options['except']); foreach ($methods as $i => $method) { if (in_array($method, $options['except'])) { unset($methods[$i]); } } } if (in_array('index', $methods)) { $this->get($name, $new_name . '::index', $options); } if (in_array('new', $methods)) { $this->get($name . '/new', $new_name . '::new', $options); } if (in_array('edit', $methods)) { $this->get($name . '/' . $id . '/edit', $new_name . '::edit/$1', $options); } if (in_array('show', $methods)) { $this->get($name . '/' . $id, $new_name . '::show/$1', $options); } if (in_array('create', $methods)) { $this->post($name, $new_name . '::create', $options); } if (in_array('update', $methods)) { $this->put($name . '/' . $id, $new_name . '::update/$1', $options); $this->patch($name . '/' . $id, $new_name . '::update/$1', $options); } if (in_array('delete', $methods)) { $this->delete($name . '/' . $id, $new_name . '::delete/$1', $options); } // Web Safe? delete needs checking before update because of method name if (isset($options['websafe'])) { if (in_array('delete', $methods)) { $this->post($name . '/' . $id . '/delete', $new_name . '::delete/$1', $options); } if (in_array('update', $methods)) { $this->post($name . '/' . $id, $new_name . '::update/$1', $options); } } return $this; } /** * Creates a collections of HTTP-verb based routes for a presenter controller. * * Possible Options: * 'controller' - Customize the name of the controller used in the 'to' route * 'placeholder' - The regex used by the Router. Defaults to '(:any)' * * Example: * * $route->presenter('photos'); * * // Generates the following routes: * HTTP Verb | Path | Action | Used for... * ----------+-------------+---------------+----------------- * GET /photos index showing all array of photo objects * GET /photos/show/{id} show showing a specific photo object, all properties * GET /photos/new new showing a form for an empty photo object, with default properties * POST /photos/create create processing the form for a new photo * GET /photos/edit/{id} edit show an editing form for a specific photo object, editable properties * POST /photos/update/{id} update process the editing form data * GET /photos/remove/{id} remove show a form to confirm deletion of a specific photo object * POST /photos/delete/{id} delete deleting the specified photo object * * @param string $name The name of the controller to route to. * @param array|null $options An list of possible ways to customize the routing. * * @return RouteCollectionInterface */ public function presenter(string $name, array $options = null): RouteCollectionInterface { // In order to allow customization of the route the // resources are sent to, we need to have a new name // to store the values in. $newName = ucfirst($name); // If a new controller is specified, then we replace the // $name value with the name of the new controller. if (isset($options['controller'])) { $newName = ucfirst(filter_var($options['controller'], FILTER_SANITIZE_STRING)); } // In order to allow customization of allowed id values // we need someplace to store them. $id = $this->placeholders[$this->defaultPlaceholder] ?? '(:segment)'; if (isset($options['placeholder'])) { $id = $options['placeholder']; } // Make sure we capture back-references $id = '(' . trim($id, '()') . ')'; $methods = isset($options['only']) ? (is_string($options['only']) ? explode(',', $options['only']) : $options['only']) : ['index', 'show', 'new', 'create', 'edit', 'update', 'remove', 'delete']; if (isset($options['except'])) { $options['except'] = is_array($options['except']) ? $options['except'] : explode(',', $options['except']); foreach ($methods as $i => $method) { if (in_array($method, $options['except'])) { unset($methods[$i]); } } } if (in_array('index', $methods)) { $this->get($name, $newName . '::index', $options); } if (in_array('show', $methods)) { $this->get($name . '/show/' . $id, $newName . '::show/$1', $options); } if (in_array('new', $methods)) { $this->get($name . '/new', $newName . '::new', $options); } if (in_array('create', $methods)) { $this->post($name . '/create', $newName . '::create', $options); } if (in_array('edit', $methods)) { $this->get($name . '/edit/' . $id, $newName . '::edit/$1', $options); } if (in_array('update', $methods)) { $this->post($name . '/update/' . $id, $newName . '::update/$1', $options); } if (in_array('remove', $methods)) { $this->get($name . '/remove/' . $id, $newName . '::remove/$1', $options); } if (in_array('delete', $methods)) { $this->post($name . '/delete/' . $id, $newName . '::delete/$1', $options); } if (in_array('show', $methods)) { $this->get($name . '/' . $id, $newName . '::show/$1', $options); } if (in_array('create', $methods)) { $this->post($name, $newName . '::create', $options); } return $this; } //-------------------------------------------------------------------- /** * Specifies a single route to match for multiple HTTP Verbs. * * Example: * $route->match( ['get', 'post'], 'users/(:num)', 'users/$1); * * @param array $verbs * @param string $from * @param string|array $to * @param array|null $options * * @return \CodeIgniter\Router\RouteCollectionInterface */ public function match(array $verbs = [], string $from, $to, array $options = null): RouteCollectionInterface { foreach ($verbs as $verb) { $verb = strtolower($verb); $this->{$verb}($from, $to, $options); } return $this; } //-------------------------------------------------------------------- /** * Specifies a route that is only available to GET requests. * * @param string $from * @param string|array $to * @param array|null $options * * @return \CodeIgniter\Router\RouteCollectionInterface */ public function get(string $from, $to, array $options = null): RouteCollectionInterface { $this->create('get', $from, $to, $options); return $this; } //-------------------------------------------------------------------- /** * Specifies a route that is only available to POST requests. * * @param string $from * @param string|array $to * @param array|null $options * * @return \CodeIgniter\Router\RouteCollectionInterface */ public function post(string $from, $to, array $options = null): RouteCollectionInterface { $this->create('post', $from, $to, $options); return $this; } //-------------------------------------------------------------------- /** * Specifies a route that is only available to PUT requests. * * @param string $from * @param string|array $to * @param array|null $options * * @return \CodeIgniter\Router\RouteCollectionInterface */ public function put(string $from, $to, array $options = null): RouteCollectionInterface { $this->create('put', $from, $to, $options); return $this; } //-------------------------------------------------------------------- /** * Specifies a route that is only available to DELETE requests. * * @param string $from * @param string|array $to * @param array|null $options * * @return \CodeIgniter\Router\RouteCollectionInterface */ public function delete(string $from, $to, array $options = null): RouteCollectionInterface { $this->create('delete', $from, $to, $options); return $this; } //-------------------------------------------------------------------- /** * Specifies a route that is only available to HEAD requests. * * @param string $from * @param string|array $to * @param array|null $options * * @return \CodeIgniter\Router\RouteCollectionInterface */ public function head(string $from, $to, array $options = null): RouteCollectionInterface { $this->create('head', $from, $to, $options); return $this; } //-------------------------------------------------------------------- /** * Specifies a route that is only available to PATCH requests. * * @param string $from * @param string|array $to * @param array|null $options * * @return \CodeIgniter\Router\RouteCollectionInterface */ public function patch(string $from, $to, array $options = null): RouteCollectionInterface { $this->create('patch', $from, $to, $options); return $this; } //-------------------------------------------------------------------- /** * Specifies a route that is only available to OPTIONS requests. * * @param string $from * @param string|array $to * @param array|null $options * * @return \CodeIgniter\Router\RouteCollectionInterface */ public function options(string $from, $to, array $options = null): RouteCollectionInterface { $this->create('options', $from, $to, $options); return $this; } //-------------------------------------------------------------------- /** * Specifies a route that is only available to command-line requests. * * @param string $from * @param string|array $to * @param array|null $options * * @return \CodeIgniter\Router\RouteCollectionInterface */ public function cli(string $from, $to, array $options = null): RouteCollectionInterface { $this->create('cli', $from, $to, $options); return $this; } //-------------------------------------------------------------------- /** * Limits the routes to a specified ENVIRONMENT or they won't run. * * @param string $env * @param \Closure $callback * * @return \CodeIgniter\Router\RouteCollectionInterface */ public function environment(string $env, \Closure $callback): RouteCollectionInterface { if (ENVIRONMENT === $env) { $callback($this); } return $this; } //-------------------------------------------------------------------- /** * Attempts to look up a route based on its destination. * * If a route exists: * * 'path/(:any)/(:any)' => 'Controller::method/$1/$2' * * This method allows you to know the Controller and method * and get the route that leads to it. * * // Equals 'path/$param1/$param2' * reverseRoute('Controller::method', $param1, $param2); * * @param string $search * @param array ...$params * * @return string|false */ public function reverseRoute(string $search, ...$params) { // Named routes get higher priority. foreach ($this->routes as $collection) { if (array_key_exists($search, $collection)) { $route = $this->fillRouteParams(key($collection[$search]['route']), $params); return $this->localizeRoute($route); } } // If it's not a named route, then loop over // all routes to find a match. foreach ($this->routes as $collection) { foreach ($collection as $route) { $from = key($route['route']); $to = $route['route'][$from]; // ignore closures if (! is_string($to)) { continue; } // Lose any namespace slash at beginning of strings // to ensure more consistent match. $to = ltrim($to, '\\'); $search = ltrim($search, '\\'); // If there's any chance of a match, then it will // be with $search at the beginning of the $to string. if (strpos($to, $search) !== 0) { continue; } // Ensure that the number of $params given here // matches the number of back-references in the route if (substr_count($to, '$') !== count($params)) { continue; } $route = $this->fillRouteParams($from, $params); return $this->localizeRoute($route); } } // If we're still here, then we did not find a match. return false; } //-------------------------------------------------------------------- /** * Replaces the {locale} tag with the current application locale * * @param string $route * * @return string */ protected function localizeRoute(string $route) :string { return strtr($route, ['{locale}' => Services::request()->getLocale()]); } //-------------------------------------------------------------------- /** * Checks a route (using the "from") to see if it's filtered or not. * * @param string $search * * @return boolean */ public function isFiltered(string $search): bool { return isset($this->routesOptions[$search]['filter']); } //-------------------------------------------------------------------- /** * Returns the filter that should be applied for a single route, along * with any parameters it might have. Parameters are found by splitting * the parameter name on a colon to separate the filter name from the parameter list, * and the splitting the result on commas. So: * * 'role:admin,manager' * * has a filter of "role", with parameters of ['admin', 'manager']. * * @param string $search * * @return string */ public function getFilterForRoute(string $search): string { if (! $this->isFiltered($search)) { return ''; } return $this->routesOptions[$search]['filter']; } //-------------------------------------------------------------------- /** * Given a * * @param string $from * @param array|null $params * * @return string * @throws \CodeIgniter\Router\Exceptions\RouterException */ protected function fillRouteParams(string $from, array $params = null): string { // Find all of our back-references in the original route preg_match_all('/\(([^)]+)\)/', $from, $matches); if (empty($matches[0])) { return '/' . ltrim($from, '/'); } // Build our resulting string, inserting the $params in // the appropriate places. foreach ($matches[0] as $index => $pattern) { // Ensure that the param we're inserting matches // the expected param type. $pos = strpos($from, $pattern); if (preg_match('#^' . $pattern . '$#u', $params[$index])) { $from = substr_replace($from, $params[$index], $pos, strlen($pattern)); } else { throw RouterException::forInvalidParameterType(); } } return '/' . ltrim($from, '/'); } //-------------------------------------------------------------------- /** * Does the heavy lifting of creating an actual route. You must specify * the request method(s) that this route will work for. They can be separated * by a pipe character "|" if there is more than one. * * @param string $verb * @param string $from * @param string|array $to * @param array|null $options */ protected function create(string $verb, string $from, $to, array $options = null) { $overwrite = false; $prefix = is_null($this->group) ? '' : $this->group . '/'; $from = filter_var($prefix . $from, FILTER_SANITIZE_STRING); // While we want to add a route within a group of '/', // it doesn't work with matching, so remove them... if ($from !== '/') { $from = trim($from, '/'); } $options = array_merge((array) $this->currentOptions, (array) $options); // Hostname limiting? if (! empty($options['hostname'])) { // @todo determine if there's a way to whitelist hosts? if (isset($_SERVER['HTTP_HOST']) && strtolower($_SERVER['HTTP_HOST']) !== strtolower($options['hostname'])) { return; } $overwrite = true; } // Limiting to subdomains? else if (! empty($options['subdomain'])) { // If we don't match the current subdomain, then // we don't need to add the route. if (! $this->checkSubdomains($options['subdomain'])) { return; } $overwrite = true; } // Are we offsetting the binds? // If so, take care of them here in one // fell swoop. if (isset($options['offset']) && is_string($to)) { // Get a constant string to work with. $to = preg_replace('/(\$\d+)/', '$X', $to); for ($i = (int) $options['offset'] + 1; $i < (int) $options['offset'] + 7; $i ++) { $to = preg_replace_callback( '/\$X/', function ($m) use ($i) { return '$' . $i; }, $to, 1 ); } } // Replace our regex pattern placeholders with the actual thing // so that the Router doesn't need to know about any of this. foreach ($this->placeholders as $tag => $pattern) { $from = str_ireplace(':' . $tag, $pattern, $from); } //If is redirect, No processing if (! isset($options['redirect'])) { // If no namespace found, add the default namespace if (is_string($to) && (strpos($to, '\\') === false || strpos($to, '\\') > 0)) { $namespace = $options['namespace'] ?? $this->defaultNamespace; $to = trim($namespace, '\\') . '\\' . $to; } // Always ensure that we escape our namespace so we're not pointing to // \CodeIgniter\Routes\Controller::method. if (is_string($to)) { $to = '\\' . ltrim($to, '\\'); } } $name = $options['as'] ?? $from; // Don't overwrite any existing 'froms' so that auto-discovered routes // do not overwrite any app/Config/Routes settings. The app // routes should always be the "source of truth". // this works only because discovered routes are added just prior // to attempting to route the request. if (isset($this->routes[$verb][$name]) && ! $overwrite) { return; } $this->routes[$verb][$name] = [ 'route' => [$from => $to], ]; $this->routesOptions[$from] = $options; // Is this a redirect? if (isset($options['redirect']) && is_numeric($options['redirect'])) { $this->routes['*'][$name]['redirect'] = $options['redirect']; } } //-------------------------------------------------------------------- /** * Compares the subdomain(s) passed in against the current subdomain * on this page request. * * @param mixed $subdomains * * @return boolean */ private function checkSubdomains($subdomains): bool { // CLI calls can't be on subdomain. if (! isset($_SERVER['HTTP_HOST'])) { return false; } if (is_null($this->currentSubdomain)) { $this->currentSubdomain = $this->determineCurrentSubdomain(); } if (! is_array($subdomains)) { $subdomains = [$subdomains]; } // Routes can be limited to any sub-domain. In that case, though, // it does require a sub-domain to be present. if (! empty($this->currentSubdomain) && in_array('*', $subdomains)) { return true; } return in_array($this->currentSubdomain, $subdomains, true); } //-------------------------------------------------------------------- /** * Examines the HTTP_HOST to get a best match for the subdomain. It * won't be perfect, but should work for our needs. * * It's especially not perfect since it's possible to register a domain * with a period (.) as part of the domain name. * * @return mixed */ private function determineCurrentSubdomain() { // We have to ensure that a scheme exists // on the URL else parse_url will mis-interpret // 'host' as the 'path'. $url = $_SERVER['HTTP_HOST']; if (strpos($url, 'http') !== 0) { $url = 'http://' . $url; } $parsedUrl = parse_url($url); $host = explode('.', $parsedUrl['host']); if ($host[0] === 'www') { unset($host[0]); } // Get rid of any domains, which will be the last unset($host[count($host)]); // Account for .co.uk, .co.nz, etc. domains if (end($host) === 'co') { $host = array_slice($host, 0, -1); } // If we only have 1 part left, then we don't have a sub-domain. if (count($host) === 1) { // Set it to false so we don't make it back here again. return false; } return array_shift($host); } //-------------------------------------------------------------------- /** * Reset the routes, so that a FeatureTestCase can provide the * explicit ones needed for it. */ public function resetRoutes() { $this->routes = ['*' => []]; foreach ($this->defaultHTTPMethods as $verb) { $this->routes[$verb] = []; } } } |
Commits for paulgoughbooks_old/trunk/system/Router/RouteCollection.php
Revision | Author | Commited | Message |
---|---|---|---|
2 | tporter | Tue 03 Nov, 2020 08:50:21 +0000 | Migration of Paul Goughs Books site to Codeignitor 4 |