This repository has been archived by the owner on Jan 8, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
/
Part.php
221 lines (190 loc) · 6.38 KB
/
Part.php
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
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\Mvc\Router\Http;
use Traversable;
use Zend\Mvc\Router\Exception;
use Zend\Mvc\Router\PriorityList;
use Zend\Mvc\Router\RoutePluginManager;
use Zend\Stdlib\ArrayUtils;
use Zend\Stdlib\RequestInterface as Request;
/**
* RouteInterface part.
*
* @see http://guides.rubyonrails.org/routing.html
*/
class Part extends TreeRouteStack implements RouteInterface
{
/**
* RouteInterface to match.
*
* @var RouteInterface
*/
protected $route;
/**
* Whether the route may terminate.
*
* @var bool
*/
protected $mayTerminate;
/**
* Child routes.
*
* @var mixed
*/
protected $childRoutes;
/**
* Create a new part route.
*
* @param mixed $route
* @param bool $mayTerminate
* @param RoutePluginManager $routePlugins
* @param array|null $childRoutes
* @throws Exception\InvalidArgumentException
*/
public function __construct($route, $mayTerminate, RoutePluginManager $routePlugins, array $childRoutes = null)
{
$this->routePluginManager = $routePlugins;
if (!$route instanceof RouteInterface) {
$route = $this->routeFromArray($route);
}
if ($route instanceof self) {
throw new Exception\InvalidArgumentException('Base route may not be a part route');
}
$this->route = $route;
$this->mayTerminate = $mayTerminate;
$this->childRoutes = $childRoutes;
$this->routes = new PriorityList();
}
/**
* factory(): defined by RouteInterface interface.
*
* @see Route::factory()
* @param mixed $options
* @throws Exception\InvalidArgumentException
* @return Part
*/
public static function factory($options = array())
{
if ($options instanceof Traversable) {
$options = ArrayUtils::iteratorToArray($options);
} elseif (!is_array($options)) {
throw new Exception\InvalidArgumentException(__METHOD__ . ' expects an array or Traversable set of options');
}
if (!isset($options['route'])) {
throw new Exception\InvalidArgumentException('Missing "route" in options array');
}
if (!isset($options['route_plugins'])) {
throw new Exception\InvalidArgumentException('Missing "route_plugins" in options array');
}
if (!isset($options['may_terminate'])) {
$options['may_terminate'] = false;
}
if (!isset($options['child_routes']) || !$options['child_routes']) {
$options['child_routes'] = null;
}
if ($options['child_routes'] instanceof Traversable) {
$options['child_routes'] = ArrayUtils::iteratorToArray($options['child_routes']);
}
return new static($options['route'], $options['may_terminate'], $options['route_plugins'], $options['child_routes']);
}
/**
* match(): defined by RouteInterface interface.
*
* @see Route::match()
* @param Request $request
* @param int|null $pathOffset
* @return RouteMatch|null
*/
public function match(Request $request, $pathOffset = null)
{
if ($pathOffset === null) {
$pathOffset = 0;
}
$match = $this->route->match($request, $pathOffset);
if ($match !== null && method_exists($request, 'getUri')) {
if ($this->childRoutes !== null) {
$this->addRoutes($this->childRoutes);
$this->childRoutes = null;
}
$nextOffset = $pathOffset + $match->getLength();
$uri = $request->getUri();
$pathLength = strlen($uri->getPath());
if ($this->mayTerminate && $nextOffset === $pathLength) {
$query = $uri->getQuery();
if ('' == trim($query) || !$this->hasQueryChild()) {
return $match;
}
}
foreach ($this->routes as $name => $route) {
if (($subMatch = $route->match($request, $nextOffset)) instanceof RouteMatch) {
if ($match->getLength() + $subMatch->getLength() + $pathOffset === $pathLength) {
return $match->merge($subMatch)->setMatchedRouteName($name);
}
}
}
}
return null;
}
/**
* assemble(): Defined by RouteInterface interface.
*
* @see Route::assemble()
* @param array $params
* @param array $options
* @return mixed
* @throws Exception\RuntimeException
*/
public function assemble(array $params = array(), array $options = array())
{
if ($this->childRoutes !== null) {
$this->addRoutes($this->childRoutes);
$this->childRoutes = null;
}
$options['has_child'] = (isset($options['name']));
$path = $this->route->assemble($params, $options);
$params = array_diff_key($params, array_flip($this->route->getAssembledParams()));
if (!isset($options['name'])) {
if (!$this->mayTerminate) {
throw new Exception\RuntimeException('Part route may not terminate');
} else {
return $path;
}
}
unset($options['has_child']);
$options['only_return_path'] = true;
$path .= parent::assemble($params, $options);
return $path;
}
/**
* getAssembledParams(): defined by RouteInterface interface.
*
* @see Route::getAssembledParams
* @return array
*/
public function getAssembledParams()
{
// Part routes may not occur as base route of other part routes, so we
// don't have to return anything here.
return array();
}
/**
* Is one of the child routes a query route?
*
* @return bool
*/
protected function hasQueryChild()
{
foreach ($this->routes as $route) {
if ($route instanceof Query) {
return true;
}
}
return false;
}
}