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: <?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 Flídr (https://github.com/mvccore/mvccore)
* @license https://mvccore.github.io/docs/mvccore/4.0.0/LICENCE.md
*/
namespace MvcCore;
/**
* Core route:
* - describing request input, url output, controller/action target and default params
* - required properties to set:
* - Pattern - classic preg_match() pattern including border '#' characters, containing char groups
* - Reverse - url form with {%param} replacements where to insert param values from url method
* - Controller - controller to create and dispatch or view directory name, pascal case
* - Action - controller action to execute or view name to render, pascal case
* - Name - 'Controller:Action' or any custom route name how to create url in application by Url() method
* - Params - default params to set before controller/action dispatching if no params in request
*/
class Route {
/**
* Route name, your custom keyword/term
* or pascal case combination of 'Controller:Action'.
* @var string
*/
public $Name = '';
/**
* Controller name in pascal case.
* @var string
*/
public $Controller = '';
/**
* Action name in pascal case.
* @var string
*/
public $Action = '';
/**
* Route preg_match pattern in classic PHP form:
* "#^/url\-begin/([^/]*)/([^/]*)/(.*)#".
* @var string
*/
public $Pattern = '';
/**
* Route reverse address form from preg_replace pattern
* in form: "/url-begin/{%first}/{%second}/{%third}".
* @var string
*/
public $Reverse = '';
/**
* Route params with default values in form:
* array('first' => 1, 'second' => 2, 'third' => 3).
* @var array
*/
public $Params = array();
/**
* Get new instance by array or stdClass, if created, return it
* @param array|\stdClass $object route configuration data
* @return \MvcCore\Route
*/
public static function GetInstance ($object) {
if (gettype($object) == 'array') {
return new static($object);
} else {
return new static((array) $object);
}
}
/**
* Create new route
* @param $nameOrConfig string|array required
* @param $controller string optional
* @param $action string optional
* @param $pattern string optional
* @param $reverse string optional
* @param $params array optional
*/
public function __construct ($nameOrConfig = NULL, $controller = NULL, $action = NULL, $pattern = NULL, $reverse = NULL, $params = array()) {
$args = func_get_args();
if (count($args) == 1 && gettype($args[0]) == 'array') {
$data = (object) $args[0];
$name = isset($data->name) ? $data->name : '';
$controller = isset($data->controller) ? $data->controller : '';
$action = isset($data->action) ? $data->action : '';
$pattern = isset($data->pattern) ? $data->pattern : '';
$reverse = isset($data->reverse) ? $data->reverse : '';
$params = isset($data->params) ? $data->params : array();
} else {
list($name, $controller, $action, $pattern, $reverse, $params) = $args;
}
if (!$controller && !$action && strpos($name, ':') !== FALSE) {
list($controller, $action) = explode(':', $name);
}
$this->Name = $name;
$this->Controller = $controller;
$this->Action = $action;
$this->Pattern = $pattern;
$this->Reverse = $reverse ? $reverse : trim($pattern, '#^$');
$this->Params = $params;
}
/**
* Set route name, your custom keyword/term
* or pascal case combination of 'Controller:Action'
* @param string $name
* @return \MvcCore\Route
*/
public function SetName ($name) {
$this->Name = $name;
return $this;
}
/**
* Set controller name in pascal case.
* @param string $controller
* @return \MvcCore\Route
*/
public function SetController ($controller) {
$this->Controller = $controller;
return $this;
}
/**
* Set action name in pascal case.
* @param string $action
* @return \MvcCore\Route
*/
public function SetAction ($action) {
$this->Action = $action;
return $this;
}
/**
* Set route preg_match pattern in classic PHP form:
* "#^/url\-begin/([^/]*)/([^/]*)/(.*)#".
* @param string $pattern
* @return \MvcCore\Route
*/
public function SetPattern ($pattern) {
$this->Pattern = $pattern;
return $this;
}
/**
* Set route reverse address form from preg_replace pattern
* in form: "/url-begin/{%first}/{%second}/{%third}".
* @param string $reverse
* @return \MvcCore\Route
*/
public function SetReverse ($reverse) {
$this->Reverse = $reverse;
return $this;
}
/**
* Set route params with default values in form:
* array('first' => 1, 'second' => 2, 'third' => 3).
* @param array $params
* @return \MvcCore\Route
*/
public function SetParams ($params = array()) {
$this->Params = $params;
return $this;
}
}