forked from zendframework/zendframework
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Mvc.php
532 lines (470 loc) · 13.8 KB
/
Mvc.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
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
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
<?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\Navigation\Page;
use Zend\Mvc\ModuleRouteListener;
use Zend\Mvc\Router\RouteMatch;
use Zend\Mvc\Router\RouteStackInterface;
use Zend\Navigation\Exception;
/**
* Represents a page that is defined using controller, action, route
* name and route params to assemble the href
*/
class Mvc extends AbstractPage
{
/**
* Action name to use when assembling URL
*
* @var string
*/
protected $action;
/**
* Controller name to use when assembling URL
*
* @var string
*/
protected $controller;
/**
* URL query part to use when assembling URL
*
* @var array|string
*/
protected $query;
/**
* Params to use when assembling URL
*
* @see getHref()
* @var array
*/
protected $params = array();
/**
* RouteInterface name to use when assembling URL
*
* @see getHref()
* @var string
*/
protected $route;
/**
* Cached href
*
* The use of this variable minimizes execution time when getHref() is
* called more than once during the lifetime of a request. If a property
* is updated, the cache is invalidated.
*
* @var string
*/
protected $hrefCache;
/**
* RouteInterface matches; used for routing parameters and testing validity
*
* @var RouteMatch
*/
protected $routeMatch;
/**
* If true and set routeMatch than getHref will use routeMatch params
* to assemble uri
* @var bool
*/
protected $useRouteMatch = false;
/**
* Router for assembling URLs
*
* @see getHref()
* @var RouteStackInterface
*/
protected $router = null;
/**
* Default router to be used if router is not given.
*
* @see getHref()
*
* @var RouteStackInterface
*/
protected static $defaultRouter= null;
// Accessors:
/**
* Returns whether page should be considered active or not
*
* This method will compare the page properties against the route matches
* composed in the object.
*
* @param bool $recursive [optional] whether page should be considered
* active if any child pages are active. Default is
* false.
* @return bool whether page should be considered active or not
*/
public function isActive($recursive = false)
{
if (!$this->active) {
$reqParams = array();
if ($this->routeMatch instanceof RouteMatch) {
$reqParams = $this->routeMatch->getParams();
if (isset($reqParams[ModuleRouteListener::ORIGINAL_CONTROLLER])) {
$reqParams['controller'] = $reqParams[ModuleRouteListener::ORIGINAL_CONTROLLER];
}
$myParams = $this->params;
if (null !== $this->controller) {
$myParams['controller'] = $this->controller;
}
if (null !== $this->action) {
$myParams['action'] = $this->action;
}
if (null !== $this->getRoute()) {
if (
$this->routeMatch->getMatchedRouteName() === $this->getRoute()
&& (count(array_intersect_assoc($reqParams, $myParams)) == count($myParams))
) {
$this->active = true;
return $this->active;
} else {
return parent::isActive($recursive);
}
}
}
$myParams = $this->params;
if (null !== $this->controller) {
$myParams['controller'] = $this->controller;
} else {
/**
* @todo In ZF1, this was configurable and pulled from the front controller
*/
$myParams['controller'] = 'index';
}
if (null !== $this->action) {
$myParams['action'] = $this->action;
} else {
/**
* @todo In ZF1, this was configurable and pulled from the front controller
*/
$myParams['action'] = 'index';
}
if (count(array_intersect_assoc($reqParams, $myParams)) == count($myParams)) {
$this->active = true;
return true;
}
}
return parent::isActive($recursive);
}
/**
* Returns href for this page
*
* This method uses {@link RouteStackInterface} to assemble
* the href based on the page's properties.
*
* @see RouteStackInterface
* @return string page href
* @throws Exception\DomainException if no router is set
*/
public function getHref()
{
if ($this->hrefCache) {
return $this->hrefCache;
}
$router = $this->router;
if (null === $router) {
$router = static::$defaultRouter;
}
if (!$router instanceof RouteStackInterface) {
throw new Exception\DomainException(
__METHOD__
. ' cannot execute as no Zend\Mvc\Router\RouteStackInterface instance is composed'
);
}
if ($this->useRouteMatch() && $this->getRouteMatch()) {
$rmParams = $this->getRouteMatch()->getParams();
if (isset($rmParams[ModuleRouteListener::ORIGINAL_CONTROLLER])) {
$rmParams['controller'] = $rmParams[ModuleRouteListener::ORIGINAL_CONTROLLER];
unset($rmParams[ModuleRouteListener::ORIGINAL_CONTROLLER]);
}
if (isset($rmParams[ModuleRouteListener::MODULE_NAMESPACE])) {
unset($rmParams[ModuleRouteListener::MODULE_NAMESPACE]);
}
$params = array_merge($rmParams, $this->getParams());
} else {
$params = $this->getParams();
}
if (($param = $this->getController()) != null) {
$params['controller'] = $param;
}
if (($param = $this->getAction()) != null) {
$params['action'] = $param;
}
switch (true) {
case ($this->getRoute() !== null):
$name = $this->getRoute();
break;
case ($this->getRouteMatch() !== null):
$name = $this->getRouteMatch()->getMatchedRouteName();
break;
default:
throw new Exception\DomainException('No route name could be found');
}
$options = array('name' => $name);
// Add the fragment identifier if it is set
$fragment = $this->getFragment();
if (null !== $fragment) {
$options['fragment'] = $fragment;
}
if (null !== ($query = $this->getQuery())) {
$options['query'] = $query;
}
$url = $router->assemble($params, $options);
return $this->hrefCache = $url;
}
/**
* Sets action name to use when assembling URL
*
* @see getHref()
*
* @param string $action action name
* @return Mvc fluent interface, returns self
* @throws Exception\InvalidArgumentException if invalid $action is given
*/
public function setAction($action)
{
if (null !== $action && !is_string($action)) {
throw new Exception\InvalidArgumentException(
'Invalid argument: $action must be a string or null'
);
}
$this->action = $action;
$this->hrefCache = null;
return $this;
}
/**
* Returns action name to use when assembling URL
*
* @see getHref()
*
* @return string|null action name
*/
public function getAction()
{
return $this->action;
}
/**
* Sets controller name to use when assembling URL
*
* @see getHref()
*
* @param string|null $controller controller name
* @return Mvc fluent interface, returns self
* @throws Exception\InvalidArgumentException if invalid controller name is given
*/
public function setController($controller)
{
if (null !== $controller && !is_string($controller)) {
throw new Exception\InvalidArgumentException(
'Invalid argument: $controller must be a string or null'
);
}
$this->controller = $controller;
$this->hrefCache = null;
return $this;
}
/**
* Returns controller name to use when assembling URL
*
* @see getHref()
*
* @return string|null controller name or null
*/
public function getController()
{
return $this->controller;
}
/**
* Sets URL query part to use when assembling URL
*
* @see getHref()
* @param array|string|null $query URL query part
* @return self fluent interface, returns self
*/
public function setQuery($query)
{
$this->query = $query;
$this->hrefCache = null;
return $this;
}
/**
* Returns URL query part to use when assembling URL
*
* @see getHref()
*
* @return array|string|null URL query part (as an array or string) or null
*/
public function getQuery()
{
return $this->query;
}
/**
* Sets params to use when assembling URL
*
* @see getHref()
* @param array|null $params [optional] page params. Default is null
* which sets no params.
* @return Mvc fluent interface, returns self
*/
public function setParams(array $params = null)
{
if (null === $params) {
$this->params = array();
} else {
// TODO: do this more intelligently?
$this->params = $params;
}
$this->hrefCache = null;
return $this;
}
/**
* Returns params to use when assembling URL
*
* @see getHref()
*
* @return array page params
*/
public function getParams()
{
return $this->params;
}
/**
* Sets route name to use when assembling URL
*
* @see getHref()
*
* @param string $route route name to use when assembling URL
* @return Mvc fluent interface, returns self
* @throws Exception\InvalidArgumentException if invalid $route is given
*/
public function setRoute($route)
{
if (null !== $route && (!is_string($route) || strlen($route) < 1)) {
throw new Exception\InvalidArgumentException(
'Invalid argument: $route must be a non-empty string or null'
);
}
$this->route = $route;
$this->hrefCache = null;
return $this;
}
/**
* Returns route name to use when assembling URL
*
* @see getHref()
*
* @return string route name
*/
public function getRoute()
{
return $this->route;
}
/**
* Get the route match.
*
* @return \Zend\Mvc\Router\RouteMatch
*/
public function getRouteMatch()
{
return $this->routeMatch;
}
/**
* Set route match object from which parameters will be retrieved
*
* @param RouteMatch $matches
* @return Mvc fluent interface, returns self
*/
public function setRouteMatch(RouteMatch $matches)
{
$this->routeMatch = $matches;
return $this;
}
/**
* Get the useRouteMatch flag
*
* @return bool
*/
public function useRouteMatch()
{
return $this->useRouteMatch;
}
/**
* Set whether the page should use route match params for assembling link uri
*
* @see getHref()
* @param bool $useRouteMatch [optional]
* @return Mvc
*/
public function setUseRouteMatch($useRouteMatch = true)
{
$this->useRouteMatch = (bool) $useRouteMatch;
$this->hrefCache = null;
return $this;
}
/**
* Get the router.
*
* @return null|RouteStackInterface
*/
public function getRouter()
{
return $this->router;
}
/**
* Sets router for assembling URLs
*
* @see getHref()
*
* @param RouteStackInterface $router Router
* @return Mvc fluent interface, returns self
*/
public function setRouter(RouteStackInterface $router)
{
$this->router = $router;
return $this;
}
/**
* Sets the default router for assembling URLs.
*
* @see getHref()
* @param RouteStackInterface $router Router
* @return void
*/
public static function setDefaultRouter($router)
{
static::$defaultRouter = $router;
}
/**
* Gets the default router for assembling URLs.
*
* @return RouteStackInterface
*/
public static function getDefaultRouter()
{
return static::$defaultRouter;
}
// Public methods:
/**
* Returns an array representation of the page
*
* @return array associative array containing all page properties
*/
public function toArray()
{
return array_merge(
parent::toArray(),
array(
'action' => $this->getAction(),
'controller' => $this->getController(),
'params' => $this->getParams(),
'route' => $this->getRoute(),
'router' => $this->getRouter(),
'route_match' => $this->getRouteMatch(),
)
);
}
}