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
|
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\Mvc\View\Console;
use Zend\EventManager\AbstractListenerAggregate;
use Zend\EventManager\EventManagerInterface;
use Zend\Mvc\Application;
use Zend\Mvc\MvcEvent;
use Zend\Stdlib\ResponseInterface as Response;
use Zend\View\Model\ConsoleModel;
class ExceptionStrategy extends AbstractListenerAggregate
{
/**
* Display exceptions?
* @var bool
*/
protected $displayExceptions = true;
/**
* A template for message to show in console when an exception has occurred.
* @var string|callable
*/
protected $message = <<<EOT
======================================================================
The application has thrown an exception!
======================================================================
:className
:message
----------------------------------------------------------------------
:file::line
:stack
======================================================================
Previous Exception(s):
:previous
EOT;
/**
* A template for message to show in console when an exception has previous exceptions.
* @var string
*/
protected $previousMessage = <<<EOT
======================================================================
:className
:message
----------------------------------------------------------------------
:file::line
:stack
EOT;
/**
* {@inheritDoc}
*/
public function attach(EventManagerInterface $events)
{
$this->listeners[] = $events->attach(MvcEvent::EVENT_DISPATCH_ERROR, array($this, 'prepareExceptionViewModel'));
$this->listeners[] = $events->attach(MvcEvent::EVENT_RENDER_ERROR, array($this, 'prepareExceptionViewModel'));
}
/**
* Flag: display exceptions in error pages?
*
* @param bool $displayExceptions
* @return ExceptionStrategy
*/
public function setDisplayExceptions($displayExceptions)
{
$this->displayExceptions = (bool) $displayExceptions;
return $this;
}
/**
* Should we display exceptions in error pages?
*
* @return bool
*/
public function displayExceptions()
{
return $this->displayExceptions;
}
/**
* Get current template for message that will be shown in Console.
*
* @return string
*/
public function getMessage()
{
return $this->message;
}
/**
* Set template for message that will be shown in Console.
* The message can be a string (template) or a callable (i.e. a closure).
*
* The closure is expected to return a string and will be called with 2 parameters:
* Exception $exception - the exception being thrown
* boolean $displayExceptions - whether to display exceptions or not
*
* If the message is a string, one can use the following template params:
*
* :className - full class name of exception instance
* :message - exception message
* :code - exception code
* :file - the file where the exception has been thrown
* :line - the line where the exception has been thrown
* :stack - full exception stack
*
* @param string|callable $message
* @return ExceptionStrategy
*/
public function setMessage($message)
{
$this->message = $message;
return $this;
}
/**
* Sets template for previous message that will be shown in Console.
*
* @param string $previousMessage
* @return ExceptionStrategy
*/
public function setPreviousMessage($previousMessage)
{
$this->previousMessage = $previousMessage;
return $this;
}
/**
* @return callable|string
*/
public function getPreviousMessage()
{
return $this->previousMessage;
}
/**
* Create an exception view model, and set the HTTP status code
*
* @todo dispatch.error does not halt dispatch unless a response is
* returned. As such, we likely need to trigger rendering as a low
* priority dispatch.error event (or goto a render event) to ensure
* rendering occurs, and that munging of view models occurs when
* expected.
* @param MvcEvent $e
* @return void
*/
public function prepareExceptionViewModel(MvcEvent $e)
{
// Do nothing if no error in the event
$error = $e->getError();
if (empty($error)) {
return;
}
// Do nothing if the result is a response object
$result = $e->getResult();
if ($result instanceof Response) {
return;
}
switch ($error) {
case Application::ERROR_CONTROLLER_NOT_FOUND:
case Application::ERROR_CONTROLLER_INVALID:
case Application::ERROR_ROUTER_NO_MATCH:
// Specifically not handling these because they are handled by routeNotFound strategy
return;
case Application::ERROR_EXCEPTION:
default:
// Prepare error message
$exception = $e->getParam('exception');
if (is_callable($this->message)) {
$callback = $this->message;
$message = (string) $callback($exception, $this->displayExceptions);
} elseif ($this->displayExceptions && $exception instanceof \Exception) {
$previous = '';
$previousException = $exception->getPrevious();
while ($previousException) {
$previous .= str_replace(
array(
':className',
':message',
':code',
':file',
':line',
':stack',
),
array(
get_class($previousException),
$previousException->getMessage(),
$previousException->getCode(),
$previousException->getFile(),
$previousException->getLine(),
$exception->getTraceAsString(),
),
$this->previousMessage
);
$previousException = $previousException->getPrevious();
}
/* @var $exception \Exception */
$message = str_replace(
array(
':className',
':message',
':code',
':file',
':line',
':stack',
':previous',
), array(
get_class($exception),
$exception->getMessage(),
$exception->getCode(),
$exception->getFile(),
$exception->getLine(),
$exception->getTraceAsString(),
$previous
),
$this->message
);
} else {
$message = str_replace(
array(
':className',
':message',
':code',
':file',
':line',
':stack',
':previous',
), array(
'',
'',
'',
'',
'',
'',
'',
),
$this->message
);
}
// Prepare view model
$model = new ConsoleModel();
$model->setResult($message);
$model->setErrorLevel(1);
// Inject it into MvcEvent
$e->setResult($model);
break;
}
}
}
|
