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: <?php
/**
* MvcCore
*
* This source file is subject to the BSD 3 License
* For the full copyright and license information, please view
* the LICENSE.md file that are distributed with this source code.
*
* @copyright Copyright (c) 2016 Tom Flidr (https://github.com/mvccore)
* @license https://mvccore.github.io/docs/mvccore/5.0.0/LICENCE.md
*/
namespace MvcCore;
/**
* Responsibility - describing request(s) to match and reversely build URL addresses.
* - Describing request to match and target it (read more about properties).
* - Matching request by given request object, see `\MvcCore\Route::Matches()`.
* - Completing URL address by given params array, see `\MvcCore\Route::Url()`.
*/
interface IRoute extends \MvcCore\Route\IConstants {
/**
* Create every time new route instance, no singleton managing.
* Called usually from core methods:
* - `\MvcCore\Router::AddRoutes();`
* - `\MvcCore\Router::AddRoute();`
* - `\MvcCore\Router::SetOrCreateDefaultRouteAsCurrent();`
* This method is the best place where to implement custom route init for
* configured core class. First argument could be configuration array with
* all necessary constructor values or all separated arguments - first is
* route pattern value to parse into match and reverse values, then
* controller with action, params default values and constraints.
* Example:
* `new Route([
* "pattern" => "/products-list/<name>/<color>",
* "controllerAction" => "Products:List",
* "defaults" => ["name" => "default-name", "color" => "red"],
* "constraints" => ["name" => "[^/]*", "color" => "[a-z]*"]
* ]);`
* or:
* `new Route(
* "/products-list/<name>/<color>",
* "Products:List",
* ["name" => "default-name", "color" => "red"],
* ["name" => "[^/]*", "color" => "[a-z]*"]
* );`
* or:
* `new Route([
* "name" => "products_list",
* "match" => "#^/products\-list/(?<name>[^/]*)/(?<color>[a-z]*)(?=/$|$)#",
* "reverse" => "/products-list/<name>/<color>",
* "controller" => "Products",
* "action" => "List",
* "defaults" => ["name" => "default-name", "color" => "red"],
* ]);`
* @param string|array $patternOrConfig
* Required, configuration array or route pattern value
* to parse into match and reverse patterns.
* @param string $controllerAction
* Optional, controller and action name in pascal case
* like: `"Products:List"`.
* @param array $defaults
* Optional, default param values like:
* `["name" => "default-name", "page" => 1]`.
* @param array $constraints
* Optional, params regular expression constraints for
* regular expression match function if no `"match"`
* property in config array as first argument defined.
* @param array $advancedConfiguration
* Optional, http method to only match requests by this
* method. If `NULL` (by default), request with any http
* method could be matched by this route. Given value is
* automatically converted to upper case.
* @return \MvcCore\Route
*/
public static function CreateInstance (
$patternOrConfig = NULL,
$controllerAction = NULL,
$defaults = [],
$constraints = [],
$method = NULL
);
/**
* Get route base pattern to complete match pattern string to match requested
* URL and to complete reverse pattern string to build back an URL address.
*
* To define route by this form is the most comfortable way, but a way
* slower, because there is necessary every request to convert this value
* into `match` and into `reverse` properties correctly. But you can specify
* those both properties directly, if you can write regular expressions.
*
* This match and reverse definition has to be in very basic form without
* regular expression escaping or advanced rules:
* - No regular expression border `#` characters, it's used in `match` only.
* - No start `^` or end `$` regular expression chars, also used in `match`.
* - No escaping of regular expression characters: `[](){}<>|=+*.!?-/`,
* those characters will be escaped in route `match` property.
* - Star character inside param name (`<color*>`) means greedy param
* matching all to the end of the URL address. It has to be the last one.
*
* Example: `"/products-list/<name>[/<color*>]"`.
* @return string|array|NULL
*/
public function GetPattern ();
/**
* Set route base pattern to complete match pattern string to match requested
* URL and to complete reverse pattern string to build back an URL address.
*
* To define route by this form is the most comfortable way, but a way
* slower, because there is necessary every request to convert this value
* into `match` and into `reverse` properties correctly. But you can specify
* those both properties directly, if you can write regular expressions.
*
* This match and reverse definition has to be in very basic form without
* regular expression escaping or advanced rules:
* - No regular expression border `#` characters, it's used in `match` only.
* - No start `^` or end `$` regular expression chars, also used in `match`.
* - No escaping of regular expression characters: `[](){}<>|=+*.!?-/`,
* those characters will be escaped in route `match` property.
* - Star character inside param name (`<color*>`) means greedy param
* matching all to the end of the URL address. It has to be the last one.
*
* Example: `"/products-list/<name>[/<color*>]"`.
* @param string|array $pattern
* @return \MvcCore\Route
*/
public function SetPattern ($pattern);
/**
* Get route match pattern in raw form (to use it as it is) to match requested
* URL. This `match` pattern must have the very same structure and content
* as `reverse` pattern, because there is necessary to complete route flags
* from `reverse` pattern string - to prepare proper regular expression
* subject for this `match`, not just only the request `path`. Because those
* flags is not possible to detect from raw regular expression string.
*
* This is required together with route `reverse` property, if you have not
* configured route `pattern` property instead.
*
* To define the route by assigning properties route `match` and route
* `reverse` together is little bit more annoying way to define it (because
* you have to write almost the same information twice), but it's the best
* speed solution, because there is no route internal metadata completion
* and `pattern` parsing into `match` and `reverse` properties.
*
* Example: `"#^/products\-list/(?<name>[^/]+)(/(?<id>\d+))?/?$#"`
* @return string|array|NULL
*/
public function GetMatch ();
/**
* Set route match pattern in raw form (to use it as it is) to match requested
* URL. This `match` pattern must have the very same structure and content
* as `reverse` pattern, because there is necessary to complete route flags
* from `reverse` pattern string - to prepare proper regular expression
* subject for this `match`, not just only the request `path`. Because those
* flags is not possible to detect from raw regular expression string.
*
* This is required together with route `reverse` property, if you have not
* configured route `pattern` property instead.
*
* To define the route by assigning properties route `match` and route
* `reverse` together is little bit more annoying way to define it (because
* you have to write almost the same information twice), but it's the best
* speed solution, because there is no route internal metadata completion
* and `pattern` parsing into `match` and `reverse` properties.
*
* Example: `"#^/products\-list/(?<name>[^/]+)(/(?<id>\d+))?/?$#"`
* @param string|array $match
* @return \MvcCore\Route
*/
public function SetMatch ($match);
/**
* Get route reverse address replacements pattern to build url.
* - No regular expression border `#` characters.
* - No regular expression characters escaping (`[](){}<>|=+*.!?-/`).
* - No start `^` or end `$` regular expression characters.
*
* Required together with route `match` property, if you have not configured
* route `pattern` property instead. This is only very simple string with
* variable section definitions defined by brackets `[]` and with parameters
* replacement places (like `<name>` or `<page>`) for given values by
* `\MvcCore\Router::Url($name, $params);` method.
*
* To define the route by assigning properties route `match` and route
* `reverse` together is little bit more annoying way to define it (because
* you have to write almost the same information twice), but it's the best
* speed solution, because there is no route internal metadata completion
* and `pattern` parsing into `match` and `reverse` properties.
*
* Example: `"/products-list/<name>[/<color>]"`
* @return string|array|NULL
*/
public function GetReverse ();
/**
* Set route reverse address replacements pattern to build url.
* - No regular expression border `#` characters.
* - No regular expression characters escaping (`[](){}<>|=+*.!?-/`).
* - No start `^` or end `$` regular expression characters.
*
* Required together with route `match` property, if you have not configured
* route `pattern` property instead. This is only very simple string with
* variable section definitions defined by brackets `[]` and with parameters
* replacement places (like `<name>` or `<page>`) for given values by
* `\MvcCore\Router::Url($name, $params);` method.
*
* To define the route by assigning properties route `match` and route
* `reverse` together is little bit more annoying way to define it (because
* you have to write almost the same information twice), but it's the best
* speed solution, because there is no route internal metadata completion
* and `pattern` parsing into `match` and `reverse` properties.
*
* Example: `"/products-list/<name>[/<color>]"`
* @param string|array $reverse
* @return \MvcCore\Route
*/
public function SetReverse ($reverse);
/**
* Get route name is your custom keyword/term or pascal case combination of
* controller and action describing `"Controller:Action"` target to be
* dispatched. Route name is not required route property.
*
* By this name there is selected proper route object to complete URL string
* by given params in router method: `\MvcCore\Router:Url($name, $params);`.
*
* Example: `"products_list" | "Products:Gallery"`
* @return string|NULL
*/
public function GetName ();
/**
* Set route name is your custom keyword/term or pascal case combination of
* controller and action describing `"Controller:Action"` target to be
* dispatched. Route name is not required route property.
*
* By this name there is selected proper route object to complete URL string
* by given params in router method: `\MvcCore\Router:Url($name, $params);`.
*
* Example: `"products_list" | "Products:Gallery"`
* @param string|NULL $name
* @return \MvcCore\Route
*/
public function SetName ($name);
/**
* Get controller name/path to dispatch, in pascal case. This property is not
* required. If there is `controller` param inside route `pattern` or inside
* route `match` pattern property, it's used to define this record to dispatch
* specific requested controller.
*
* It should contain controller class namespaces defined in standard PHP
* notation. If there is backslash at the beginning - controller class will
* be loaded directly from base standard controllers directory
* `/App/Controllers`, not by any relative place defined by possible domain
* route from extended router. If there are two standard slashes in the
* beginning, controller class will be loaded without those two slashes
* from base PHP place without any automatic MvcCore namespace prepending.
*
* Example:
* `"Products"` - normally placed in /App/Controllers/Products.php` (but it
* could be also in some sub-directory if there is used
* extended route with namespace)
* `"\Front\Business\Products"`
* - placed in `/App/Controllers/Front/Business/Products.php`
* `"//Anywhere\Else\Controllers\Products"
* - placed in `/Anywhere/Else/Controllers/Products.php`
* @return string
*/
public function GetController ();
/**
* Set controller name/path to dispatch, in pascal case. This property is not
* required. If there is `controller` param inside route `pattern` or inside
* route `match` pattern property, it's used to define this record to dispatch
* specific requested controller.
*
* It should contain controller class namespaces defined in standard PHP
* notation. If there is backslash at the beginning - controller class will
* be loaded directly from base standard controllers directory
* `/App/Controllers`, not by any relative place defined by possible domain
* route from extended router. If there are two standard slashes in the
* beginning, controller class will be loaded without those two slashes
* from base PHP place without any automatic MvcCore namespace prepending.
*
* Example:
* `"Products"` - normally placed in /App/Controllers/Products.php` (but it
* could be also in some sub-directory if there is used
* extended route with namespace)
* `"\Front\Business\Products"`
* - placed in `/App/Controllers/Front/Business/Products.php`
* `"//Anywhere\Else\Controllers\Products"
* - placed in `/Anywhere/Else/Controllers/Products.php`
* @param string|NULL $controller
* @return \MvcCore\Route
*/
public function SetController ($controller);
/**
* Get action name to call in dispatched controller, in pascal case. This
* property is not required. If controller instance has default method
* `IndexAction()`, its called. If there is no such method, no method is
* called. If there is `action` param inside route `pattern` or inside route
* `match` pattern property, it's used to overwrite this record to dispatch
* specific requested action.
*
* If this property has value `"List"`, then public method in target
* controller has to be named as: `public function ListAction () {...}`.
*
* Example: `"List"`
* @return string
*/
public function GetAction ();
/**
* Set action name to call in dispatched controller, in pascal case. This
* property is not required. If controller instance has default method
* `IndexAction()`, its called. If there is no such method, no method is
* called. If there is `action` param inside route `pattern` or inside route
* `match` pattern property, it's used to overwrite this record to dispatch
* specific requested action.
*
* If this property has value `"List"`, then public method in target
* controller has to be named as: `public function ListAction () {...}`.
*
* Example: `"List"`
* @param string|NULL $action
* @return \MvcCore\Route
*/
public function SetAction ($action);
/**
* Get target controller name/path and controller action name together in
* one getter, in pascal case, separated by colon. There are also contained
* controller namespace. Read more about controller name/path definition
* possibilities in `\MvcCore\Route::GetController();` getter method.
*
* Example: `"Products:List" | "\Front\Business\Products:Gallery"`
* @return string
*/
public function GetControllerAction ();
/**
* Set target controller name/path and controller action name together in
* one setter, in pascal case, separated by colon. There are also contained
* controller namespace. Read more about controller name/path definition
* possibilities in `\MvcCore\Route::SetController();` setter method.
*
* Example: `"Products:List" | "\Front\Business\Products:Gallery"`
* @return \MvcCore\Route
*/
public function SetControllerAction ($controllerAction);
/**
* Get route rewrite params default values and also any other query string
* params default values. It could be used for any application request
* param from those application inputs - `$_GET`, `$_POST` or `php://input`.
*
* Example: `["name" => "default-name", "color" => "red",]`.
* @return array|\array[]
*/
public function & GetDefaults ();
/**
* Set route rewrite params default values and also any other query string
* params default values. It could be used for any application request
* param from those application inputs - `$_GET`, `$_POST` or `php://input`.
*
* Example: `["name" => "default-name", "color" => "red",]`.
* @param array|\array[] $defaults
* @return \MvcCore\Route
*/
public function SetDefaults ($defaults = []);
/**
* Get array with param names and their custom regular expression matching
* rules. Not required, for all rewrite params there is used default
* matching rules from route static properties `defaultDomainConstraint` or
* `defaultPathConstraint`. It should be changed to any value. Default value
* is `"[^.]+"` for domain part and `"[^/]+"` for path part.
*
* Example: `["name" => "[^/]+", "color" => "[a-z]+",]`
* @return array|\array[]
*/
public function GetConstraints ();
/**
* Set array with param names and their custom regular expression matching
* rules. Not required, for all rewrite params there is used default
* matching rules from route static properties `defaultDomainConstraint` or
* `defaultPathConstraint`. It should be changed to any value. Default value
* is `"[^.]+"` for domain part and `"[^/]+"` for path part.
*
* Example: `["name" => "[^/]+", "color" => "[a-z]+",]`
* @param array|\array[] $constraints
* @return \MvcCore\Route
*/
public function SetConstraints ($constraints = []);
/**
* Get URL address params filters to filter URL params in and out. By route
* filters you can change incoming request params into application and out
* from application. For example to translate the values or anything else.
*
* Filters are `callable`s and always in this array under keys `"in"` and
* `"out"` accepting arguments:
* - `$params` associative array with params from requested URL address for
* in filter and associative array with params to build URL
* address for out filter.
* - `$defaultParams` associative array with default params to store
* any custom value necessary to filter effectively.
* - `$request` current request instance implements `\MvcCore\IRequest`.
*
* `Callable` filter must return associative `array` with filtered params.
*
* There is possible to call any `callable` as closure function in variable
* except forms like `'ClassName::methodName'` and `['childClassName',
* 'parent::methodName']` and `[$childInstance, 'parent::methodName']`.
* @return array|\callable[]
*/
public function & GetFilters ();
/**
* Set URL address params filters to filter URL params in and out. By route
* filters you can change incoming request params into application and out
* from application. For example to translate the values or anything else.
*
* Filters are `callable`s and always in this array under keys `"in"` and
* `"out"` accepting arguments:
* - `$params` associative array with params from requested URL address for
* in filter and associative array with params to build URL
* address for out filter.
* - `$defaultParams` associative array with default params to store
* any custom value necessary to filter effectively.
* - `$request` current request instance implements `\MvcCore\IRequest`.
*
* `Callable` filter must return associative `array` with filtered params.
*
* There is possible to call any `callable` as closure function in variable
* except forms like `'ClassName::methodName'` and `['childClassName',
* 'parent::methodName']` and `[$childInstance, 'parent::methodName']`.
* @param array|\callable[] $filters
* @return \MvcCore\Route
*/
public function SetFilters (array $filters = []);
/**
* Get URL address params filter to filter URL params in and out. By route
* filter you can change incoming request params into application and out
* from application. For example to translate the values or anything else.
*
* Filter is `callable` accepting arguments:
* - `$params` associative array with params from requested URL address for
* in filter and associative array with params to build URL
* address for out filter.
* - `$defaultParams` associative array with default params to store
* any custom value necessary to filter effectively.
* - `$request` current request instance implements `\MvcCore\IRequest`.
*
* `Callable` filter must return associative `array` with filtered params.
*
* There is possible to call any `callable` as closure function in variable
* except forms like `'ClassName::methodName'` and `['childClassName',
* 'parent::methodName']` and `[$childInstance, 'parent::methodName']`.
* @return \callable|NULL
*/
public function GetFilter ($direction = \MvcCore\IRoute::CONFIG_FILTER_IN);
/**
* Set URL address params filter to filter URL params in and out. By route
* filter you can change incoming request params into application and out
* from application. For example to translate the values or anything else.
*
* Filter is `callable` accepting arguments:
* - `$params` associative array with params from requested URL address for
* in filter and associative array with params to build URL
* address for out filter.
* - `$defaultParams` associative array with default params to store
* any custom value necessary to filter effectively.
* - `$request` current request instance implements `\MvcCore\IRequest`.
*
* `Callable` filter must return associative `array` with filtered params.
*
* There is possible to call any `callable` as closure function in variable
* except forms like `'ClassName::methodName'` and `['childClassName',
* 'parent::methodName']` and `[$childInstance, 'parent::methodName']`.
* @param \callable $handler
* @param string $direction
* @return \MvcCore\Route
*/
public function SetFilter ($handler, $direction = \MvcCore\IRoute::CONFIG_FILTER_IN);
/**
* Get http method to only match requests with this defined method. If `NULL`,
* request with any http method could be matched by this route. Value has to
* be in upper case.
* Example: `"POST" | \MvcCore\IRequest::METHOD_POST`
* @return string|NULL
*/
public function GetMethod ();
/**
* Set http method to only match requests with this defined method. If `NULL`,
* request with any http method could be matched by this route. Value has to
* be in upper case.
* Example: `"POST" | \MvcCore\IRequest::METHOD_POST`
* @param string|NULL $method
* @return \MvcCore\Route
*/
public function SetMethod ($method = NULL);
/**
* Get other route unique name to redirect request to. To this target route are
* passed params parsed from this matched route. This property is used for
* routes handling old pages or old request forms, redirecting those request
* to new form.
* Example: `"new_route_name"`
* @return string|NULL
*/
public function GetRedirect ();
/**
* Set other route unique name to redirect request to. To this target route are
* passed params parsed from this matched route. This property is used for
* routes handling old pages or old request forms, redirecting those request
* to new form.
* Example: `"new_route_name"`
* @param string|NULL $redirectRouteName
* @return \MvcCore\Route
*/
public function SetRedirect ($redirectRouteName = NULL);
/**
* Return `TRUE` if route `pattern` (or `reverse`) contains domain part with
* two slashes at the beginning or if route is defined with `absolute`
* boolean flag by advanced configuration in constructor or by setter.
* @return bool
*/
public function GetAbsolute ();
/**
* Set boolean about to generate absolute URL addresses. If `TRUE`, there is
* always generated absolute URL form. If `FALSE`, absolute URL address is
* generated only if `pattern` (or `reverse`) property contains absolute
* matching form.
* @param bool $absolute
* @return \MvcCore\Route
*/
public function SetAbsolute ($absolute = TRUE);
/**
* Get route group name to belongs to. Group name is always first word parsed
* from request path. First word is content between two first slashes in
* request path. If group name is `NULL`, route belongs to default group
* and that group is used when no other group matching the request path.
* @return string|NULL
*/
public function GetGroupName ();
/**
* Set route group name to belongs to. Group name is always first word parsed
* from request path. First word is content between two first slashes in
* request path. If group name is `NULL`, route belongs to default group
* and that group is used when no other group matching the request path.
* @param string|NULL $groupName
* @return \MvcCore\Route
*/
public function SetGroupName ($groupName);
/**
* Return only reverse params names as `string`s array. Reverse params array
* is array with all rewrite params founded in `patter` (or `reverse`) string.
* Example: `["name", "color"];`
* @return \string[]|NULL
*/
public function GetReverseParams ();
/**
* Set manually matched params from rewrite route matching process into
* current route object. Use this method only on currently matched route!
* Passed array must have keys as param names and values as matched values
* and it must contain all only matched rewrite params and route controller
* and route action if any.
* @param array $matchedParams
* @return \MvcCore\Route
*/
public function SetMatchedParams ($matchedParams = []);
/**
* Get matched params from rewrite route matching process into current route
* object. Use this method only on currently matched route! Passed array
* must have keys as param names and values as matched values and it must
* contain all only matched rewrite params and route controller and route
* action if any.
* @return array|NULL
*/
public function & GetMatchedParams ();
/**
* Get router instance reference, used mostly in route URL building process.
* @return \MvcCore\Router
*/
public function GetRouter ();
/**
* Set router instance reference, used mostly in route URL building process.
* @param \MvcCore\Router $router
* @return \MvcCore\Route
*/
public function SetRouter (\MvcCore\IRouter $router);
/**
* Get any special advanced configuration property from route constructor.
* configuration array contains data from route constructor. If route is
* initialized with all params (not only by single array), the configuration
* array used in this method contains the fourth param with advanced route
* configuration. If route is initialized only with one single array
* argument, the configuration array used in this method contains that whole
* configuration single array argument. Data in described are without no
* change against initialization moment. You can specify key to the array to
* get any initialization value.
* @param string $propertyName
* @return mixed
*/
public function GetAdvancedConfigProperty ($propertyName);
/**
* Return array of matched params if incoming request match this route
* or `NULL` if doesn't. Returned array must contain all matched reverse
* params with matched controller and action names by route and by matched
* params. Route is matched usually if request property `path` matches by
* PHP `preg_match_all()` route `match` pattern. Sometimes, matching subject
* could be different if route specifies it - if route `pattern` (or `match`)
* property contains domain (or base path part) - it means if it is absolute
* or if `pattern` (or `match`) property contains a query string part.
* This method is usually called in core request routing process
* from `\MvcCore\Router::Route();` method and it's sub-methods.
* @param \MvcCore\Request $request The request object instance.
* @throws \LogicException Route configuration property is missing.
* @throws \InvalidArgumentException Wrong route pattern format.
* @return array Matched and params array, keys are matched
* params or controller and action params.
*/
public function & Matches (\MvcCore\IRequest $request);
/**
* Filter given `array $params` by configured `"in" | "out"` filter `callable`.
* This function return `array` with first item as `bool` about successful
* filter processing in `try/catch` and second item as filtered params `array`.
* @param array $params
* @param array $defaultParams
* @param string $direction
* @return array Filtered params array.
*/
public function Filter (array & $params = [], array & $defaultParams = [], $direction = \MvcCore\IRoute::CONFIG_FILTER_IN);
/**
* Complete route URL by given params array and route internal reverse
* replacements pattern string. If there are more given params in first
* argument than total count of replacement places in reverse pattern,
* then create URL with query string params after reverse pattern,
* containing that extra record(s) value(s). Returned is an array with only
* one string as result URL or it could be returned for extended classes
* an array with two strings - result URL in two parts - first part as scheme,
* domain and base path and second as path and query string.
* Example:
* Input (`$params`):
* `[
* "name" => "cool-product-name",
* "color" => "blue",
* "variants" => ["L", "XL"],
* ];`
* Input (`\MvcCore\Route::$reverse`):
* `"/products-list/<name>/<color*>"`
* Output:
* `["/any/app/base/path/products-list/cool-product-name/blue?variant[]=L&variant[]=XL"]`
* or:
* `[
* "/any/app/base/path",
* "/products-list/cool-product-name/blue?variant[]=L&variant[]=XL"
* ]`
* @param \MvcCore\Request $request
* Currently requested request object.
* @param array $params
* URL params from application point completed
* by developer.
* @param array $defaultUrlParams
* Requested URL route params and query string
* params without escaped HTML special chars:
* `< > & " ' &`.
* @param string $queryStringParamsSepatator
* Query params separator, `&` by default. Always
* automatically completed by router instance.
* @param bool $splitUrl
* Boolean value about to split completed result URL
* into two parts or not. Default is FALSE to return
* a string array with only one record - the result
* URL. If `TRUE`, result url is split into two
* parts and function return array with two items.
* @return \string[] Result URL address in array. If last argument is
* `FALSE` by default, this function returns only
* single item array with result URL. If last
* argument is `TRUE`, function returns result URL
* in two parts - domain part with base path and
* path part with query string.
*/
public function Url (\MvcCore\IRequest $request, array & $params = [], array & $defaultUrlParams = [], $queryStringParamsSepatator = '&', $splitUrl = FALSE);
/**
* Initialize all possible protected values (`match`, `reverse` etc...). This
* method is not recommended to use in production mode, it's designed mostly
* for development purposes, to see what could be inside route object.
* @return \MvcCore\Route
*/
public function InitAll ();
/**
* Collect all properties names to serialize them by `serialize()` method.
* Collect all instance properties declared as private, protected and public
* and if there is not configured in `static::$protectedProperties` anything
* under property name, return those properties in result array.
* @return \string[]
*/
public function __sleep ();
/**
* Assign router instance to local property `$this->router;`.
* @return void
*/
public function __wakeup ();
}