This repository has been archived by the owner on Jan 8, 2020. It is now read-only.
/
RouteNotFoundStrategy.php
323 lines (288 loc) · 8.83 KB
/
RouteNotFoundStrategy.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
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @package Zend_Mvc
*/
namespace Zend\Mvc\View\Http;
use Zend\EventManager\EventManagerInterface;
use Zend\EventManager\ListenerAggregateInterface;
use Zend\Http\Response as HttpResponse;
use Zend\Mvc\Application;
use Zend\Mvc\MvcEvent;
use Zend\Stdlib\ResponseInterface as Response;
use Zend\View\Model\ViewModel;
/**
* @category Zend
* @package Zend_Mvc
* @subpackage View
*/
class RouteNotFoundStrategy implements ListenerAggregateInterface
{
/**
* @var \Zend\Stdlib\CallbackHandler[]
*/
protected $listeners = array();
/**
* Whether or not to display exceptions related to the 404 condition
*
* @var bool
*/
protected $displayExceptions = false;
/**
* Whether or not to display the reason for a 404
*
* @var bool
*/
protected $displayNotFoundReason = false;
/**
* Template to use to report page not found conditions
*
* @var string
*/
protected $notFoundTemplate = 'error';
/**
* The reason for a not-found condition
*
* @var false|string
*/
protected $reason = false;
/**
* Attach the aggregate to the specified event manager
*
* @param EventManagerInterface $events
* @return void
*/
public function attach(EventManagerInterface $events)
{
$this->listeners[] = $events->attach(MvcEvent::EVENT_DISPATCH, array($this, 'prepareNotFoundViewModel'), -90);
$this->listeners[] = $events->attach(MvcEvent::EVENT_DISPATCH_ERROR, array($this, 'detectNotFoundError'));
$this->listeners[] = $events->attach(MvcEvent::EVENT_DISPATCH_ERROR, array($this, 'prepareNotFoundViewModel'));
}
/**
* Set value indicating whether or not to display exceptions related to a not-found condition
*
* @param bool $displayExceptions
* @return RouteNotFoundStrategy
*/
public function setDisplayExceptions($displayExceptions)
{
$this->displayExceptions = (bool) $displayExceptions;
return $this;
}
/**
* Should we display exceptions related to a not-found condition?
*
* @return bool
*/
public function displayExceptions()
{
return $this->displayExceptions;
}
/**
* Detach aggregate listeners from the specified event manager
*
* @param EventManagerInterface $events
* @return void
*/
public function detach(EventManagerInterface $events)
{
foreach ($this->listeners as $index => $listener) {
if ($events->detach($listener)) {
unset($this->listeners[$index]);
}
}
}
/**
* Set value indicating whether or not to display the reason for a not-found condition
*
* @param bool $displayNotFoundReason
* @return RouteNotFoundStrategy
*/
public function setDisplayNotFoundReason($displayNotFoundReason)
{
$this->displayNotFoundReason = (bool) $displayNotFoundReason;
return $this;
}
/**
* Should we display the reason for a not-found condition?
*
* @return bool
*/
public function displayNotFoundReason()
{
return $this->displayNotFoundReason;
}
/**
* Get template for not found conditions
*
* @param string $notFoundTemplate
* @return RouteNotFoundStrategy
*/
public function setNotFoundTemplate($notFoundTemplate)
{
$this->notFoundTemplate = (string) $notFoundTemplate;
return $this;
}
/**
* Get template for not found conditions
*
* @return string
*/
public function getNotFoundTemplate()
{
return $this->notFoundTemplate;
}
/**
* Detect if an error is a 404 condition
*
* If a "controller not found" or "invalid controller" error type is
* encountered, sets the response status code to 404.
*
* @param MvcEvent $e
* @return void
*/
public function detectNotFoundError(MvcEvent $e)
{
$error = $e->getError();
if (empty($error)) {
return;
}
switch ($error) {
case Application::ERROR_CONTROLLER_NOT_FOUND:
case Application::ERROR_CONTROLLER_INVALID:
case Application::ERROR_ROUTER_NO_MATCH:
$this->reason = $error;
$response = $e->getResponse();
if (!$response) {
$response = new HttpResponse();
$e->setResponse($response);
}
$response->setStatusCode(404);
break;
default:
return;
}
}
/**
* Create and return a 404 view model
*
* @param MvcEvent $e
* @return void
*/
public function prepareNotFoundViewModel(MvcEvent $e)
{
$vars = $e->getResult();
if ($vars instanceof Response) {
// Already have a response as the result
return;
}
$response = $e->getResponse();
if ($response->getStatusCode() != 404) {
// Only handle 404 responses
return;
}
if (!$vars instanceof ViewModel) {
$model = new ViewModel();
if (is_string($vars)) {
$model->setVariable('message', $vars);
} else {
$model->setVariable('message', 'Page not found.');
}
} else {
$model = $vars;
if ($model->getVariable('message') === null) {
$model->setVariable('message', 'Page not found.');
}
}
$model->setTemplate($this->getNotFoundTemplate());
// If displaying reasons, inject the reason
$this->injectNotFoundReason($model, $e);
// If displaying exceptions, inject
$this->injectException($model, $e);
// Inject controller if we're displaying either the reason or the exception
$this->injectController($model, $e);
$e->setResult($model);
}
/**
* Inject the not-found reason into the model
*
* If $displayNotFoundReason is enabled, checks to see if $reason is set,
* and, if so, injects it into the model. If not, it injects
* Application::ERROR_CONTROLLER_CANNOT_DISPATCH.
*
* @param ViewModel $model
* @return void
*/
protected function injectNotFoundReason(ViewModel $model)
{
if (!$this->displayNotFoundReason()) {
return;
}
// no route match, controller not found, or controller invalid
if ($this->reason) {
$model->setVariable('reason', $this->reason);
return;
}
// otherwise, must be a case of the controller not being able to
// dispatch itself.
$model->setVariable('reason', Application::ERROR_CONTROLLER_CANNOT_DISPATCH);
}
/**
* Inject the exception message into the model
*
* If $displayExceptions is enabled, and an exception is found in the
* event, inject it into the model.
*
* @param ViewModel $model
* @param MvcEvent $e
* @return void
*/
protected function injectException($model, $e)
{
if (!$this->displayExceptions()) {
return;
}
$exception = $e->getParam('exception', false);
if (!$exception instanceof \Exception) {
return;
}
$model->setVariable('exception', $exception);
}
/**
* Inject the controller and controller class into the model
*
* If either $displayExceptions or $displayNotFoundReason are enabled,
* injects the controllerClass from the MvcEvent. It checks to see if a
* controller is present in the MvcEvent, and, if not, grabs it from
* the route match if present; if a controller is found, it injects it into
* the model.
*
* @param ViewModel $model
* @param MvcEvent $e
* @return void
*/
protected function injectController($model, $e)
{
if (!$this->displayExceptions() && !$this->displayNotFoundReason()) {
return;
}
$controller = $e->getController();
if (empty($controller)) {
$routeMatch = $e->getRouteMatch();
if (empty($routeMatch)) {
return;
}
$controller = $routeMatch->getParam('controller', false);
if (!$controller) {
return;
}
}
$controllerClass = $e->getControllerClass();
$model->setVariable('controller', $controller);
$model->setVariable('controller_class', $controllerClass);
}
}