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
|
<?php
/* vim: set expandtab tabstop=4 shiftwidth=4 foldmethod=marker: */
// +----------------------------------------------------------------------+
// | PEAR_Exception |
// +----------------------------------------------------------------------+
// | Copyright (c) 2004 The PEAR Group |
// +----------------------------------------------------------------------+
// | This source file is subject to version 3.0 of the PHP license, |
// | that is bundled with this package in the file LICENSE, and is |
// | available at through the world-wide-web at |
// | http://www.php.net/license/3_0.txt. |
// | If you did not receive a copy of the PHP license and are unable to |
// | obtain it through the world-wide-web, please send a note to |
// | license@php.net so we can mail you a copy immediately. |
// +----------------------------------------------------------------------+
// | Authors: Tomas V.V.Cox <cox@idecnet.com> |
// | Hans Lellelid <hans@velum.net> |
// | |
// +----------------------------------------------------------------------+
//
// $Id$
define('PEAR_OBSERVER_PRINT', -2);
define('PEAR_OBSERVER_TRIGGER', -4);
define('PEAR_OBSERVER_DIE', -8);
/**
* Base PEAR_Exception Class
*
* 1) Features:
*
* - Nestable exceptions (throw new PEAR_Exception($msg, $prev_exception))
* - Definable triggers, shot when exceptions occur
* - Pretty and informative error messages
* - Added more context info avaible (like class, method or cause)
*
* 2) Ideas:
*
* - Maybe a way to define a 'template' for the output
*
* 3) Inherited properties from PHP Exception Class:
*
* protected $message
* protected $code
* protected $line
* protected $file
* private $trace
*
* 4) Inherited methods from PHP Exception Class:
*
* __clone
* __construct
* getMessage
* getCode
* getFile
* getLine
* getTrace
* getTraceAsString
* __toString
*
* 5) Usage example
*
* <code>
* require_once 'PEAR/Exception.php';
*
* class Test {
* function foo() {
* throw new PEAR_Exception('Error Message', ERROR_CODE);
* }
* }
*
* function myLogger($pear_exception) {
* echo $pear_exception->getMessage();
* }
* // each time a exception is thrown the 'myLogger' will be called
* // (its use is completely optional)
* PEAR_Exception::addObserver('myLogger');
* $test = new Test;
* try {
* $test->foo();
* } catch (PEAR_Exception $e) {
* print $e;
* }
* </code>
*
* @since PHP 5
* @package PEAR
* @version $Revision$
* @author Tomas V.V.Cox <cox@idecnet.com>
* @author Hans Lellelid <hans@velum.net>
*
*/
class PEAR_Exception extends Exception
{
protected $cause;
protected $error_class;
protected $error_method;
private $_method;
private static $_observers = array();
/**
* Supported signatures:
* PEAR_Exception(string $message);
* PEAR_Exception(string $message, int $code);
* PEAR_Exception(string $message, Exception $cause);
* PEAR_Exception(string $message, Exception $cause, int $code);
*/
public function __construct($message, $p2 = null, $p3 = null)
{
$code = null;
$cause = null;
if (is_int($p3) && $p2 instanceof Exception) {
$code = $p3;
$cause = $p2;
} elseif (is_int($p2)) {
$code = $p2;
} elseif ($p2 instanceof Exception) {
$cause = $p2;
}
$this->cause = $cause;
$trace = parent::getTrace();
$this->error_class = $trace[0]['class'];
$this->error_method = $trace[0]['function'];
$this->_method = $this->error_class . '::' . $this->error_method . '()';
parent::__construct($message, $code);
$this->_signal();
}
/**
* @param mixed $callback - A valid php callback, see php func is_callable()
* - A PEAR_OBSERVER_* constant
* - An array(const PEAR_OBSERVER_*, mixed $options)
*
* @param string $label - The name of the observer. Use this if you want
* to remove it later with delObserver()
*/
public static function addObserver($callback, $label = 'default')
{
self::$_observers[$label] = $callback;
}
public static function delObserver($label = 'default')
{
unset(self::$_observers[$label]);
}
private function _signal()
{
foreach (self::$_observers as $func) {
if (is_callable($func)) {
call_user_func($func, $this);
continue;
}
settype($func, 'array');
switch ($func[0]) {
case PEAR_OBSERVER_PRINT:
$f = (isset($func[1])) ? $func[1] : '%s';
printf($f, $this->getMessage());
break;
case PEAR_OBSERVER_TRIGGER:
$f = (isset($func[1])) ? $func[1] : E_USER_NOTICE;
trigger_error($this->getMessage(), $f);
break;
case PEAR_OBSERVER_DIE:
$f = (isset($func[1])) ? $func[1] : '%s';
die(printf($f, $this->getMessage()));
break;
default:
trigger_error('invalid observer type', E_USER_WARNING);
}
}
}
private function _getCauseMessage()
{
$msg = " #{$this->_method} at {$this->file} ({$this->line})\n" .
" {$this->message}\n";
if ($this->cause instanceof Exception) {
return $this->cause->_getCauseMessage() . $msg;
}
return $msg;
}
/**
* @return Exception_object The context of the exception
*/
public function getCause()
{
return $this->cause;
}
public function getErrorClass()
{
return $this->error_class;
}
public function getErrorMethod()
{
return $this->error_method;
}
public function __toString()
{
$str = get_class($this) . " occurred: \n" .
" Error message: {$this->message}\n" .
" Error code : {$this->code}\n" .
" File (Line) : {$this->file} ({$this->line})\n" .
" Method : {$this->_method}\n";
if ($this->cause instanceof Exception) {
$str .= " Nested Error :\n" . $this->_getCauseMessage();
}
if (isset($_SERVER['REQUEST_URI'])) {
return nl2br('<pre>'.htmlentities($str).'</pre>');
}
return $str;
}
}
?>
|
