/
ConsoleErrorHandler.php
131 lines (122 loc) · 3.5 KB
/
ConsoleErrorHandler.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
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since 2.0.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Console;
use Cake\Error\BaseErrorHandler;
use Cake\Error\FatalErrorException;
use Exception;
/**
* Error Handler for Cake console. Does simple printing of the
* exception that occurred and the stack trace of the error.
*/
class ConsoleErrorHandler extends BaseErrorHandler
{
/**
* Standard error stream.
*
* @var ConsoleOutput
*/
protected $_stderr;
/**
* Options for this instance.
*
* @var array
*/
protected $_options;
/**
* Constructor
*
* @param array $options Options for the error handler.
*/
public function __construct($options = [])
{
if (empty($options['stderr'])) {
$options['stderr'] = new ConsoleOutput('php://stderr');
}
$this->_stderr = $options['stderr'];
$this->_options = $options;
}
/**
* Handle errors in the console environment. Writes errors to stderr,
* and logs messages if Configure::read('debug') is false.
*
* @param \Exception $exception Exception instance.
* @return void
* @throws \Exception When renderer class not found
* @see http://php.net/manual/en/function.set-exception-handler.php
*/
public function handleException(Exception $exception)
{
$this->_displayException($exception);
$this->_logException($exception);
$code = $exception->getCode();
$code = ($code && is_int($code)) ? $code : 1;
$this->_stop($code);
}
/**
* Prints an exception to stderr.
*
* @param \Exception $exception The exception to handle
* @return void
*/
protected function _displayException($exception)
{
$errorName = 'Exception:';
if ($exception instanceof FatalErrorException) {
$errorName = 'Fatal Error:';
}
$message = sprintf(
"<error>%s</error> %s in [%s, line %s]",
$errorName,
$exception->getMessage(),
$exception->getFile(),
$exception->getLine()
);
$this->_stderr->write($message);
}
/**
* Prints an error to stderr.
*
* Template method of BaseErrorHandler.
*
* @param array $error An array of error data.
* @param bool $debug Whether or not the app is in debug mode.
* @return void
*/
protected function _displayError($error, $debug)
{
$message = sprintf(
'%s in [%s, line %s]',
$error['description'],
$error['file'],
$error['line']
);
$message = sprintf(
"<error>%s Error:</error> %s\n",
$error['error'],
$message
);
$this->_stderr->write($message);
}
/**
* Stop the execution and set the exit code for the process.
*
* @param int $code The exit code.
* @return void
*/
protected function _stop($code)
{
exit($code);
}
}