{$router->__toString()}{$router->__toString()}{$router->toString()}{$string}$path$pathMethod not allowed for $method $path
The request method must be one of $allow
+ +HTML; + }; + } + + /** + * Defines callback on happen event + * + * @param string $event + * @param callable $handler + */ + public function on(string $event, $handler): void + { + if (self::isSupportedEvent($event)) { + $this->options[$event] = $handler; + } + } + + /** + * Trigger event + * + * @param string $event + * @param array $args + * + * @return mixed + * @throws InvalidArgumentException + */ + protected function fire(string $event, array $args = []): mixed + { + if (!$cb = $this->getOption($event)) { + return null; + } + + return RouteHelper::call($cb, $args); + } + + /** + * @param string $name + * @param mixed $value + */ + public function setOption(string $name, mixed $value): void + { + $this->options[$name] = $value; + } + + /** + * @param string $name + * @param mixed|null $default + * + * @return mixed + */ + public function getOption(string $name, mixed $default = null): mixed + { + return $this->options[$name] ?? $default; + } + + /** + * @return array + */ + public static function getSupportedEvents(): array + { + return [ + self::ON_FOUND, + self::ON_NOT_FOUND, + self::ON_METHOD_NOT_ALLOWED, + self::ON_EXEC_START, + self::ON_EXEC_END, + self::ON_EXEC_ERROR + ]; + } + + /** + * @param string $name + * + * @return bool + */ + public static function isSupportedEvent(string $name): bool + { + return in_array($name, static::getSupportedEvents(), true); + } + + /** + * @return bool + */ + public function hasRouter(): bool + { + return $this->router !== null; + } + + /** + * @return RouterInterface + */ + public function getRouter(): RouterInterface + { + return $this->router; + } + + /** + * @param RouterInterface $router + */ + public function setRouter(RouterInterface $router): void + { + $this->router = $router; + } + + /** + * @return array + */ + public function getOptions(): array + { + return $this->options; + } + + /** + * @param array $options + */ + public function setOptions(array $options): void + { + $this->options = array_merge($this->options, $options); + } +} diff --git a/src/DispatcherInterface.php b/src/DispatcherInterface.php deleted file mode 100644 index 849e7c1..0000000 --- a/src/DispatcherInterface.php +++ /dev/null @@ -1,40 +0,0 @@ - '/' + if (false !== strpos($path, '//')) { + $path = preg_replace('#\/\/+#', '/', $path); + } + + // Must be start withs '/' + if (strpos($path, '/') !== 0) { + $path = '/' . $path; + } + + // Decode + $path = rawurldecode($path); + + return $ignoreLastSlash ? rtrim($path, '/') : $path; + } + + /** + * convert 'first-second' to 'firstSecond' + * + * @param string $str + * @param bool $ucFirst + * + * @return string + */ + public static function str2Camel(string $str, bool $ucFirst = false): string + { + $str = trim($str, '-'); + + // convert 'first-second' to 'firstSecond' + if (strpos($str, '-')) { + $str = preg_replace_callback('/-+([a-z])/', static function ($c) { + return strtoupper($c[1]); + }, trim($str, '- ')); + } + + return $ucFirst ? ucfirst($str) : $str; + } + + /** + * handle auto route match, when config `'autoRoute' => true` + * + * @param string $path The route path + * @param string $cnp controller namespace. eg: 'app\\controllers' + * @param string $sfx controller suffix. eg: 'Controller' + * @param bool $ucFirst + * + * @return bool|string + */ + public static function parseAutoRoute(string $path, string $cnp, string $sfx, bool $ucFirst = false): bool|string + { + $tmp = trim($path, '/- '); + + // one node. eg: 'home' + if (!strpos($tmp, '/')) { + $tmp = self::str2Camel($tmp); + $class = "$cnp\\" . ucfirst($tmp) . $sfx; + + return class_exists($class) ? $class : false; + } + + $nodes = array_filter(explode('/', $tmp)); + + if ($ucFirst) { + foreach ($nodes as $i => $node) { + $nodes[$i] = self::str2Camel($nodes[$i], true); + } + } else { + $nodes = array_map(self::class . '::str2Camel', $nodes); + } + + $count = count($nodes); + + // two nodes. eg: 'home/test' 'admin/user' + if ($count === 2) { + [$n1, $n2] = $nodes; + + // last node is an controller class name. eg: 'admin/user' + $class = "$cnp\\$n1\\" . ucfirst($n2) . $sfx; + + if (class_exists($class)) { + return $class; + } + + // first node is an controller class name, second node is a action name, + $class = "$cnp\\" . ucfirst($n1) . $sfx; + + return class_exists($class) ? $class . '@' . lcfirst($n2) : false; + } + + // max allow 5 nodes + if ($count > 5) { + return false; + } + + // last node is an controller class name + $n2 = array_pop($nodes); + $class = sprintf('%s\\%s\\%s', $cnp, implode('\\', $nodes), ucfirst($n2) . $sfx); + + if (class_exists($class)) { + return $class; + } + + // last second is an controller class name, last node is a action name, + $n1 = array_pop($nodes); + $class = sprintf('%s\\%s\\%s', $cnp, implode('\\', $nodes), ucfirst($n1) . $sfx); + + return class_exists($class) ? $class . '@' . lcfirst($n2) : false; + } + + /** + * @param callable|mixed $cb + * string - func name, class name + * array - [class, method] + * object - Closure, Object + * + * @param array $args + * + * @return mixed + * @throws InvalidArgumentException + */ + public static function call($cb, array $args = []) + { + if (!$cb) { + return true; + } + + if (is_array($cb)) { + [$obj, $mhd] = $cb; + + return is_object($obj) ? $obj->$mhd(...$args) : $obj::$mhd(...$args); + } + + if (is_string($cb)) { + if (function_exists($cb)) { + return $cb(...$args); + } + + // a class name + if (class_exists($cb)) { + $cb = new $cb; + } + } + + // a \Closure or Object implement '__invoke' + if (is_object($cb) && method_exists($cb, '__invoke')) { + return $cb(...$args); + } + + throw new InvalidArgumentException('the callback handler is not callable!'); + } +} diff --git a/src/Helper/functions.php b/src/Helper/functions.php new file mode 100644 index 0000000..d9d3970 --- /dev/null +++ b/src/Helper/functions.php @@ -0,0 +1,73 @@ +completed(); + + return $router; +} + +/** + * @param Closure $closure + * @param string $path + * @param string $method + * @param array $config + * + * @return PreMatchRouter + */ +function createPreMatchRouter( + Closure $closure, + string $path = '', + string $method = '', + array $config = [] +): PreMatchRouter { + $router = new PreMatchRouter($config, $path, $method); + + $closure($router); + + return $router; +} + +/** + * @param Closure $closure + * @param array $config + * + * @return ServerRouter + */ +function createServerRouter(Closure $closure, array $config = []): ServerRouter +{ + $closure($router = new ServerRouter($config)); + + return $router; +} diff --git a/src/ORouter.php b/src/ORouter.php deleted file mode 100644 index bf72c67..0000000 --- a/src/ORouter.php +++ /dev/null @@ -1,843 +0,0 @@ -get('/user/{num}', 'handler'); - * @var array - */ - private static $globalTokens = [ - 'any' => '[^/]+', // match any except '/' - 'num' => '[0-9]+', // match a number - 'act' => '[a-zA-Z][\w-]+', // match a action name - 'all' => '.*' - ]; - - /** @var string */ - private $currentGroupPrefix; - - /** @var array */ - private $currentGroupOption; - - /** @var bool */ - private $initialized = false; - - /** - * static Routes - no dynamic argument match - * 整个路由 path 都是静态字符串 e.g. '/user/login' - * @var array - * [ - * '/user/login' => [ - * 'GET' => [ - * 'handler' => 'handler', - * 'option' => null, - * ], - * 'POST' => [ - * 'handler' => 'handler', - * 'option' => null, - * ], - * ... - * ] - * ] - */ - private $staticRoutes = []; - - /** - * regular Routes - have dynamic arguments, but the first node is normal. - * 第一节是个静态字符串，称之为有规律的动态路由。按第一节的信息进行存储 - * e.g '/hello[/{name}]' '/user/{id}' - * @var array[] - * [ - * // 先用第一个字符作为 key，进行分组 - * 'a' => [ - * // 第一节只有一个字符, 使用关键字'_NO_'为 key 进行分组 - * '_NO_' => [ - * [ - * 'first' => '/a', - * 'regex' => '/a/(\w+)', - * 'method' => 'GET', - * 'handler' => 'handler', - * 'option' => null, - * ] - * ], - * // 第一节有多个字符, 使用第二个字符 为 key 进行分组 - * 'd' => [ - * [ - * 'first' => '/add', - * 'regex' => '/add/(\w+)', - * 'method' => 'GET', - * 'handler' => 'handler', - * 'option' => null, - * ], - * ... ... - * ], - * ... ... - * ], - * 'b' => [ - * 'l' => [ - * [ - * 'first' => '/blog', - * 'regex' => '/blog/(\w+)', - * 'method' => 'GET', - * 'handler' => 'handler', - * 'option' => null, - * ], - * ... ... - * ], - * ... ... - * ], - * ] - */ - private $regularRoutes = []; - - /** - * vague Routes - have dynamic arguments,but the first node is exists regex. - * 第一节就包含了正则匹配，称之为无规律/模糊的动态路由 - * e.g '/{some}/{some2}' - * - * @var array - * [ - * [ - * 'regex' => '/(\w+)/some', - * 'method' => 'GET', - * 'handler' => 'handler', - * 'option' => null, - * ], - * ... ... - * ] - */ - private $vagueRoutes = []; - - /** - * There are last route caches - * @var array - * [ - * 'path' => [ - * 'GET' => [ - * 'handler' => 'handler', - * 'option' => null, - * ], - * 'POST' => [ - * 'handler' => 'handler', - * 'option' => null, - * ], - * ... ... - * ] - * ] - */ - private $routeCaches = []; - - /** - * some setting for self - * @var array - */ - private $config = [ - // ignore last '/' char. If is True, will clear last '/'. - 'ignoreLastSep' => false, - - // 'tmpCacheNumber' => 100, - 'tmpCacheNumber' => 0, - - // match all request. - // 1. If is a valid URI path, will match all request uri to the path. - // 2. If is a closure, will match all request then call it - // eg: '/site/maintenance' or `function () { echo 'System Maintaining ... ...'; }` - 'matchAll' => '', - - // auto route match @like yii framework - // If is True, will auto find the handler controller file. - 'autoRoute' => false, - // The default controllers namespace, is valid when `'enable' = true` - 'controllerNamespace' => '', // eg: 'app\\controllers' - // controller suffix, is valid when `'enable' = true` - 'controllerSuffix' => '', // eg: 'Controller' - ]; - - /** @var DispatcherInterface */ - private $dispatcher; - - /** - * object creator. - * @param array $config - * @return self - * @throws \LogicException - */ - public static function make(array $config = []) - { - return new static($config); - } - - /** - * object constructor. - * @param array $config - * @throws \LogicException - */ - public function __construct(array $config = []) - { - $this->setConfig($config); - - $this->currentGroupPrefix = ''; - $this->currentGroupOption = []; - } - - /** - * @param array $config - * @throws \LogicException - */ - public function setConfig(array $config) - { - if ($this->initialized) { - throw new \LogicException('Routing has been added, and configuration is not allowed!'); - } - - foreach ($config as $name => $value) { - if (isset($this->config[$name])) { - $this->config[$name] = $value; - } - } - } - -////////////////////////////////////////////////////////////////////// -/// route collection -////////////////////////////////////////////////////////////////////// - - /** - * Defines a route callback and method - * @param string $method - * @param array $args - * @return ORouter - * @throws \LogicException - * @throws \InvalidArgumentException - */ - public function __call($method, array $args) - { - if (count($args) < 2) { - throw new \InvalidArgumentException("The method [$method] parameters is missing."); - } - - return $this->map($method, $args[0], $args[1], isset($args[2]) ? $args[2] : []); - } - - /** - * Create a route group with a common prefix. - * All routes created in the passed callback will have the given group prefix prepended. - * - * @from package 'nikic/fast-route' - * @param string $prefix - * @param \Closure $callback - * @param array $opts - */ - public function group($prefix, \Closure $callback, array $opts = []) - { - $previousGroupPrefix = $this->currentGroupPrefix; - $this->currentGroupPrefix = $previousGroupPrefix . '/' . trim($prefix, '/'); - - $previousGroupOption = $this->currentGroupOption; - $this->currentGroupOption = $opts; - - $callback($this); - - $this->currentGroupPrefix = $previousGroupPrefix; - $this->currentGroupOption = $previousGroupOption; - } - - /** - * @param string|array $method The match request method. - * e.g - * string: 'get' - * array: ['get','post'] - * @param string $route The route path string. eg: '/user/login' - * @param callable|string $handler - * @param array $opts some option data - * [ - * 'tokens' => [ 'id' => '[0-9]+', ], - * 'domains' => [ 'a-domain.com', '*.b-domain.com'], - * 'schema' => 'https', - * ] - * @return static - * @throws \LogicException - * @throws \InvalidArgumentException - */ - public function map($method, $route, $handler, array $opts = []) - { - if (!$this->initialized) { - $this->initialized = true; - } - - // array - if (is_array($method)) { - foreach ((array)$method as $m) { - $this->map($m, $route, $handler, $opts); - } - - return $this; - } - - // string - register route and callback - - $method = strtoupper($method); - $hasPrefix = (bool)$this->currentGroupPrefix; - - // validate arguments - static::validateArguments($method, $handler); - - if ($route = trim($route)) { - // always add '/' prefix. - $route = $route{0} === '/' ? $route : '/' . $route; - } elseif (!$hasPrefix) { - $route = '/'; - } - - $route = $this->currentGroupPrefix . $route; - - // setting 'ignoreLastSep' - if ($route !== '/' && $this->config['ignoreLastSep']) { - $route = rtrim($route, '/'); - } - - $this->routeCounter++; - $opts = array_replace([ - 'tokens' => null, - 'domains' => null, - 'schema' => null, // ['http','https'], - // route event. custom design ... - // 'enter' => null, - // 'leave' => null, - ], $this->currentGroupOption, $opts); - - $conf = [ - 'method' => $method, - 'handler' => $handler, - 'option' => $opts, - ]; - - // no dynamic param tokens - if (strpos($route, '{') === false) { - $this->staticRoutes[$route][$method] = $conf; - - return $this; - } - - // have dynamic param tokens - - // replace token name To pattern regex - list($first, $conf) = static::parseRoute( - $route, - static::getAvailableTokens(self::$globalTokens, $opts['tokens']), - $conf - ); - - // route string is regular - if ($first) { - $twoLevelKey = isset($first{1}) ? $first{1} : self::DEFAULT_TWO_LEVEL_KEY; - $this->regularRoutes[$first{0}][$twoLevelKey][] = $conf; - } else { - $this->vagueRoutes[] = $conf; - } - - return $this; - } - - /** - * @param $method - * @param $handler - * @throws \InvalidArgumentException - */ - public static function validateArguments($method, $handler) - { - $supStr = implode('|', self::SUPPORTED_METHODS); - - if (false === strpos('|' . $supStr . '|', '|' . $method . '|')) { - throw new \InvalidArgumentException("The method [$method] is not supported, Allow: $supStr"); - } - - if (!$handler || (!is_string($handler) && !is_object($handler))) { - throw new \InvalidArgumentException('The route handler is not empty and type only allow: string,object'); - } - - if (is_object($handler) && !is_callable($handler)) { - throw new \InvalidArgumentException('The route object handler must be is callable'); - } - } - - /** - * @param string $route - * @param array $tokens - * @param array $conf - * @return string - * @throws \LogicException - */ - public static function parseRoute($route, array $tokens, array $conf) - { - $first = null; - $tmp = $route; - - // 解析可选参数位 - // '/hello[/{name}]' match: /hello/tom /hello - // '/my[/{name}[/{age}]]' match: /my/tom/78 /my/tom - if (false !== strpos($route, ']')) { - $withoutClosingOptionals = rtrim($route, ']'); - $optionalNum = strlen($route) - strlen($withoutClosingOptionals); - - if ($optionalNum !== substr_count($withoutClosingOptionals, '[')) { - throw new \LogicException('Optional segments can only occur at the end of a route'); - } - - // '/hello[/{name}]' -> '/hello(?:/{name})?' - $route = str_replace(['[', ']'], ['(?:', ')?'], $route); - } - - // 解析参数，替换为对应的 正则 - if (preg_match_all('#\{([a-zA-Z_][a-zA-Z0-9_-]*)\}#', $route, $m)) { - /** @var array[] $m */ - $replacePairs = []; - - foreach ($m[1] as $name) { - $key = '{' . $name . '}'; - // 匹配定义的 token , 未匹配到的使用默认 self::DEFAULT_REGEX - $regex = isset($tokens[$name]) ? $tokens[$name] : self::DEFAULT_REGEX; - - // 将匹配结果命名 (?P