|
1
|
|
|
<?php |
|
|
|
|
|
|
2
|
|
|
|
|
3
|
|
|
declare(strict_types = 1); |
|
4
|
|
|
|
|
5
|
|
|
namespace Jarvis\Skill\Routing; |
|
6
|
|
|
|
|
7
|
|
|
use FastRoute\{ |
|
8
|
|
|
DataGenerator\GroupCountBased as DataGenerator, |
|
9
|
|
|
Dispatcher\GroupCountBased as Dispatcher, |
|
10
|
|
|
RouteParser\Std as Parser, |
|
11
|
|
|
RouteCollector |
|
12
|
|
|
}; |
|
13
|
|
|
use Jarvis\{Jarvis, Skill\Core\ScopeManager}; |
|
14
|
|
|
|
|
15
|
|
|
/** |
|
16
|
|
|
* @author Eric Chau <[email protected]> |
|
17
|
|
|
*/ |
|
18
|
|
|
class Router extends Dispatcher |
|
19
|
|
|
{ |
|
20
|
|
|
private $rawRoutes = []; |
|
21
|
|
|
private $routesNames = []; |
|
22
|
|
|
private $routeCollector; |
|
23
|
|
|
private $compilationKey; |
|
24
|
|
|
private $scopeManager; |
|
25
|
|
|
|
|
26
|
|
|
public function __construct(ScopeManager $scopeManager) |
|
27
|
|
|
{ |
|
28
|
|
|
$this->scopeManager = $scopeManager; |
|
29
|
|
|
} |
|
30
|
|
|
|
|
31
|
|
|
/** |
|
32
|
|
|
* Alias to Router's route collector ::addRoute method. |
|
33
|
|
|
* @see RouteCollector::addRoute |
|
34
|
|
|
*/ |
|
35
|
|
|
public function addRoute(Route $route) : Router |
|
36
|
|
|
{ |
|
37
|
|
|
$this->rawRoutes[$route->scope()] = $this->rawRoutes[$route->scope()] ?? []; |
|
38
|
|
|
$this->rawRoutes[$route->scope()][] = [$route->method(), $route->pattern(), $route->handler()]; |
|
39
|
|
|
$this->compilationKey = null; |
|
40
|
|
|
|
|
41
|
|
|
if (null !== $name = $route->name()) { |
|
42
|
|
|
$this->routesNames[$name] = $route->pattern(); |
|
43
|
|
|
} |
|
44
|
|
|
|
|
45
|
|
|
return $this; |
|
46
|
|
|
} |
|
47
|
|
|
|
|
48
|
|
|
public function beginRoute(string $name = null) : Route |
|
49
|
|
|
{ |
|
50
|
|
|
return new Route($name, $this); |
|
51
|
|
|
} |
|
52
|
|
|
|
|
53
|
|
|
/** |
|
54
|
|
|
* Generates URI associated to provided route name. |
|
55
|
|
|
* |
|
56
|
|
|
* @param string $name The URI route name we want to generate |
|
57
|
|
|
* @param array $params Parameters to replace in pattern |
|
58
|
|
|
* @return string |
|
59
|
|
|
* @throws \InvalidArgumentException if provided route name is unknown |
|
60
|
|
|
*/ |
|
61
|
|
|
public function uri(string $name, array $params = []) : string |
|
62
|
|
|
{ |
|
63
|
|
|
if (!isset($this->routesNames[$name])) { |
|
64
|
|
|
throw new \InvalidArgumentException( |
|
65
|
|
|
"Cannot generate URI for '$name' cause it does not exist." |
|
66
|
|
|
); |
|
67
|
|
|
} |
|
68
|
|
|
|
|
69
|
|
|
$uri = $this->routesNames[$name]; |
|
70
|
|
|
foreach ($params as $key => $value) { |
|
71
|
|
|
if (1 !== preg_match("~\{($key:?[^}]*)\}~", $uri, $matches)) { |
|
72
|
|
|
continue; |
|
73
|
|
|
} |
|
74
|
|
|
|
|
75
|
|
|
$value = (string) $value; |
|
76
|
|
|
$pieces = explode(':', $matches[1]); |
|
77
|
|
|
if (1 < count($pieces) && 1 !== preg_match('~' . $pieces[1] . '~', $value)) { |
|
78
|
|
|
continue; |
|
79
|
|
|
} |
|
80
|
|
|
|
|
81
|
|
|
$uri = str_replace($matches[0], $value, $uri); |
|
82
|
|
|
} |
|
83
|
|
|
|
|
84
|
|
|
return $uri; |
|
85
|
|
|
} |
|
86
|
|
|
|
|
87
|
|
|
/** |
|
88
|
|
|
* Alias of GroupCountBased::dispatch. |
|
89
|
|
|
* {@inheritdoc} |
|
90
|
|
|
*/ |
|
91
|
|
|
public function match(string $method, string $uri) |
|
92
|
|
|
{ |
|
93
|
|
|
return $this->dispatch($method, $uri); |
|
94
|
|
|
} |
|
95
|
|
|
|
|
96
|
|
|
public function dispatch($method, $uri) |
|
97
|
|
|
{ |
|
98
|
|
|
list($this->staticRouteMap, $this->variableRouteData) = $this->routeCollector()->getData(); |
|
99
|
|
|
|
|
100
|
|
|
return parent::dispatch(strtolower($method), $uri); |
|
101
|
|
|
} |
|
102
|
|
|
|
|
103
|
|
|
private function routeCollector() : RouteCollector |
|
104
|
|
|
{ |
|
105
|
|
|
$key = $this->generateCompilationKey(); |
|
106
|
|
|
if (null === $this->compilationKey || $this->compilationKey !== $key) { |
|
107
|
|
|
$this->compilationKey = $key; |
|
108
|
|
|
$this->routeCollector = new RouteCollector(new Parser(), new DataGenerator()); |
|
109
|
|
|
|
|
110
|
|
|
$enabledRoutes = []; |
|
111
|
|
|
foreach ($this->rawRoutes as $scope => $rawRoutes) { |
|
112
|
|
|
if ($this->scopeManager->isEnabled($scope)) { |
|
113
|
|
|
$enabledRoutes = array_merge($enabledRoutes, $rawRoutes); |
|
114
|
|
|
} |
|
115
|
|
|
} |
|
116
|
|
|
|
|
117
|
|
|
foreach ($enabledRoutes as $rawRoute) { |
|
118
|
|
|
list($method, $route, $handler) = $rawRoute; |
|
119
|
|
|
$this->routeCollector->addRoute($method, $route, $handler); |
|
120
|
|
|
} |
|
121
|
|
|
} |
|
122
|
|
|
|
|
123
|
|
|
return $this->routeCollector; |
|
124
|
|
|
} |
|
125
|
|
|
|
|
126
|
|
|
private function generateCompilationKey() : string |
|
127
|
|
|
{ |
|
128
|
|
|
return md5(implode(',', $this->scopeManager->all())); |
|
129
|
|
|
} |
|
130
|
|
|
} |
|
131
|
|
|
|
eric-chau /
jarvis
The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.
The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.
To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.