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
<?php
/**
* @link http://github.com/zendframework/zend-router for the canonical source repository
* @copyright Copyright (c) 2005-2016 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\Router\Http;
use ArrayObject;
use Traversable;
use Zend\Router\Exception;
use Zend\Router\RouteInvokableFactory;
use Zend\Router\SimpleRouteStack;
use Zend\ServiceManager\Config;
use Zend\Stdlib\ArrayUtils;
use Zend\Stdlib\RequestInterface as Request;
use Zend\Uri\Http as HttpUri;
/**
* Tree search implementation.
*/
class TreeRouteStack extends SimpleRouteStack
{
/**
* Base URL.
*
* @var string
*/
protected $baseUrl;
/**
* Request URI.
*
* @var HttpUri
*/
protected $requestUri;
/**
* Prototype routes.
*
* We use an ArrayObject in this case so we can easily pass it down the tree
* by reference.
*
* @var ArrayObject
*/
protected $prototypes;
/**
* factory(): defined by RouteInterface interface.
*
* @see \Zend\Router\RouteInterface::factory()
* @param array|Traversable $options
* @return SimpleRouteStack
* @throws Exception\InvalidArgumentException
*/
public static function factory($options = [])
{
if ($options instanceof Traversable) {
$options = ArrayUtils::iteratorToArray($options);
}
if (! is_array($options)) {
throw new Exception\InvalidArgumentException(sprintf(
'%s expects an array or Traversable set of options',
__METHOD__
));
}
$instance = parent::factory($options);
if (isset($options['prototypes'])) {
$instance->addPrototypes($options['prototypes']);
}
return $instance;
}
/**
* init(): defined by SimpleRouteStack.
*
* @see SimpleRouteStack::init()
*/
protected function init()
{
$this->prototypes = new ArrayObject;
(new Config([
'aliases' => [
'chain' => Chain::class,
'Chain' => Chain::class,
'hostname' => Hostname::class,
'Hostname' => Hostname::class,
'hostName' => Hostname::class,
'HostName' => Hostname::class,
'literal' => Literal::class,
'Literal' => Literal::class,
'method' => Method::class,
'Method' => Method::class,
'part' => Part::class,
'Part' => Part::class,
'regex' => Regex::class,
'Regex' => Regex::class,
'scheme' => Scheme::class,
'Scheme' => Scheme::class,
'segment' => Segment::class,
'Segment' => Segment::class,
'wildcard' => Wildcard::class,
'Wildcard' => Wildcard::class,
'wildCard' => Wildcard::class,
'WildCard' => Wildcard::class,
],
'factories' => [
Chain::class => RouteInvokableFactory::class,
Hostname::class => RouteInvokableFactory::class,
Literal::class => RouteInvokableFactory::class,
Method::class => RouteInvokableFactory::class,
Part::class => RouteInvokableFactory::class,
Regex::class => RouteInvokableFactory::class,
Scheme::class => RouteInvokableFactory::class,
Segment::class => RouteInvokableFactory::class,
Wildcard::class => RouteInvokableFactory::class,
// v2 normalized names
'zendmvcrouterhttpchain' => RouteInvokableFactory::class,
'zendmvcrouterhttphostname' => RouteInvokableFactory::class,
'zendmvcrouterhttpliteral' => RouteInvokableFactory::class,
'zendmvcrouterhttpmethod' => RouteInvokableFactory::class,
'zendmvcrouterhttppart' => RouteInvokableFactory::class,
'zendmvcrouterhttpregex' => RouteInvokableFactory::class,
'zendmvcrouterhttpscheme' => RouteInvokableFactory::class,
'zendmvcrouterhttpsegment' => RouteInvokableFactory::class,
'zendmvcrouterhttpwildcard' => RouteInvokableFactory::class,
],
]))->configureServiceManager($this->routePluginManager);
}
/**
* addRoute(): defined by RouteStackInterface interface.
*
* @see RouteStackInterface::addRoute()
* @param string $name
* @param mixed $route
* @param int $priority
* @return TreeRouteStack
*/
public function addRoute($name, $route, $priority = null)
{
if (! $route instanceof RouteInterface) {
$route = $this->routeFromArray($route);
}
return parent::addRoute($name, $route, $priority);
}
/**
* routeFromArray(): defined by SimpleRouteStack.
*
* @see SimpleRouteStack::routeFromArray()
* @param string|array|Traversable $specs
* @return RouteInterface
* @throws Exception\InvalidArgumentException When route definition is not an array nor traversable
* @throws Exception\InvalidArgumentException When chain routes are not an array nor traversable
* @throws Exception\RuntimeException When a generated routes does not implement the HTTP route interface
*/
protected function routeFromArray($specs)
{
if (is_string($specs)) {
if (null === ($route = $this->getPrototype($specs))) {
throw new Exception\RuntimeException(sprintf('Could not find prototype with name %s', $specs));
}
return $route;
} elseif ($specs instanceof Traversable) {
$specs = ArrayUtils::iteratorToArray($specs);
} elseif (! is_array($specs)) {
throw new Exception\InvalidArgumentException('Route definition must be an array or Traversable object');
}
if (isset($specs['chain_routes'])) {
if (! is_array($specs['chain_routes'])) {
throw new Exception\InvalidArgumentException('Chain routes must be an array or Traversable object');
}
$chainRoutes = array_merge([$specs], $specs['chain_routes']);
unset($chainRoutes[0]['chain_routes']);
if (isset($specs['child_routes'])) {
unset($chainRoutes[0]['child_routes']);
}
$options = [
'routes' => $chainRoutes,
'route_plugins' => $this->routePluginManager,
'prototypes' => $this->prototypes,
];
$route = $this->routePluginManager->get('chain', $options);
} else {
$route = parent::routeFromArray($specs);
}
if (! $route instanceof RouteInterface) {
throw new Exception\RuntimeException('Given route does not implement HTTP route interface');
}
if (isset($specs['child_routes'])) {
$options = [
'route' => $route,
'may_terminate' => (isset($specs['may_terminate']) && $specs['may_terminate']),
'child_routes' => $specs['child_routes'],
'route_plugins' => $this->routePluginManager,
'prototypes' => $this->prototypes,
];
$priority = (isset($route->priority) ? $route->priority : null);
$route = $this->routePluginManager->get('part', $options);
$route->priority = $priority;
}
return $route;
}
/**
* Add multiple prototypes at once.
*
* @param Traversable $routes
* @return TreeRouteStack
* @throws Exception\InvalidArgumentException
*/
public function addPrototypes($routes)
{
if (! is_array($routes) && ! $routes instanceof Traversable) {
throw new Exception\InvalidArgumentException('addPrototypes expects an array or Traversable set of routes');
}
foreach ($routes as $name => $route) {
$this->addPrototype($name, $route);
}
return $this;
}
/**
* Add a prototype.
*
* @param string $name
* @param mixed $route
* @return TreeRouteStack
*/
public function addPrototype($name, $route)
{
if (! $route instanceof RouteInterface) {
$route = $this->routeFromArray($route);
}
$this->prototypes[$name] = $route;
return $this;
}
/**
* Get a prototype.
*
* @param string $name
* @return RouteInterface|null
*/
public function getPrototype($name)
{
if (isset($this->prototypes[$name])) {
return $this->prototypes[$name];
}
return;
}
/**
* match(): defined by \Zend\Router\RouteInterface
*
* @see \Zend\Router\RouteInterface::match()
* @param Request $request
* @param integer|null $pathOffset
* @param array $options
* @return RouteMatch|null
*/
public function match(Request $request, $pathOffset = null, array $options = [])
{
if (! method_exists($request, 'getUri')) {
return;
}
if ($this->baseUrl === null && method_exists($request, 'getBaseUrl')) {
$this->setBaseUrl($request->getBaseUrl());
}
$uri = $request->getUri();
$baseUrlLength = strlen($this->baseUrl) ?: null;
if ($pathOffset !== null) {
$baseUrlLength += $pathOffset;
}
if ($this->requestUri === null) {
$this->setRequestUri($uri);
}
if ($baseUrlLength !== null) {
$pathLength = strlen($uri->getPath()) - $baseUrlLength;
} else {
$pathLength = null;
}
foreach ($this->routes as $name => $route) {
if (($match = $route->match($request, $baseUrlLength, $options)) instanceof RouteMatch
&& ($pathLength === null || $match->getLength() === $pathLength)
) {
$match->setMatchedRouteName($name);
foreach ($this->defaultParams as $paramName => $value) {
if ($match->getParam($paramName) === null) {
$match->setParam($paramName, $value);
}
}
return $match;
}
}
return;
}
/**
* assemble(): defined by \Zend\Router\RouteInterface interface.
*
* @see \Zend\Router\RouteInterface::assemble()
* @param array $params
* @param array $options
* @return mixed
* @throws Exception\InvalidArgumentException
* @throws Exception\RuntimeException
*/
public function assemble(array $params = [], array $options = [])
{
if (! isset($options['name'])) {
throw new Exception\InvalidArgumentException('Missing "name" option');
}
$names = explode('/', $options['name'], 2);
$route = $this->routes->get($names[0]);
if (! $route) {
throw new Exception\RuntimeException(sprintf('Route with name "%s" not found', $names[0]));
}
if (isset($names[1])) {
if (! $route instanceof TreeRouteStack) {
throw new Exception\RuntimeException(sprintf(
'Route with name "%s" does not have child routes',
$names[0]
));
}
$options['name'] = $names[1];
} else {
unset($options['name']);
}
if (isset($options['only_return_path']) && $options['only_return_path']) {
return $this->baseUrl . $route->assemble(array_merge($this->defaultParams, $params), $options);
}
if (! isset($options['uri'])) {
$uri = new HttpUri();
if (isset($options['force_canonical']) && $options['force_canonical']) {
if ($this->requestUri === null) {
throw new Exception\RuntimeException('Request URI has not been set');
}
$uri->setScheme($this->requestUri->getScheme())
->setHost($this->requestUri->getHost())
->setPort($this->requestUri->getPort());
}
$options['uri'] = $uri;
} else {
$uri = $options['uri'];
}
$path = $this->baseUrl . $route->assemble(array_merge($this->defaultParams, $params), $options);
if (isset($options['query'])) {
$uri->setQuery($options['query']);
}
if (isset($options['fragment'])) {
$uri->setFragment($options['fragment']);
}
if ((isset($options['force_canonical'])
&& $options['force_canonical'])
|| $uri->getHost() !== null
|| $uri->getScheme() !== null
) {
if (($uri->getHost() === null || $uri->getScheme() === null) && $this->requestUri === null) {
throw new Exception\RuntimeException('Request URI has not been set');
}
if ($uri->getHost() === null) {
$uri->setHost($this->requestUri->getHost());
}
if ($uri->getScheme() === null) {
$uri->setScheme($this->requestUri->getScheme());
}
$uri->setPath($path);
if (! isset($options['normalize_path']) || $options['normalize_path']) {
$uri->normalize();
}
return $uri->toString();
} elseif (! $uri->isAbsolute() && $uri->isValidRelative()) {
$uri->setPath($path);
if (! isset($options['normalize_path']) || $options['normalize_path']) {
$uri->normalize();
}
return $uri->toString();
}
return $path;
}
/**
* Set the base URL.
*
* @param string $baseUrl
* @return self
*/
public function setBaseUrl($baseUrl)
{
$this->baseUrl = rtrim($baseUrl, '/');
return $this;
}
/**
* Get the base URL.
*
* @return string
*/
public function getBaseUrl()
{
return $this->baseUrl;
}
/**
* Set the request URI.
*
* @param HttpUri $uri
* @return TreeRouteStack
*/
public function setRequestUri(HttpUri $uri)
{
$this->requestUri = $uri;
return $this;
}
/**
* Get the request URI.
*
* @return HttpUri
*/
public function getRequestUri()
{
return $this->requestUri;
}
}