/
Exception.php
338 lines (311 loc) · 8.73 KB
/
Exception.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
<?php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
/**
* Doozr - Base - Exception
*
* Exception.php - Simple basic exception class of the Doozr Framework.
*
* PHP versions 5.5
*
* LICENSE:
* Doozr - The lightweight PHP-Framework for high-performance websites
*
* Copyright (c) 2005 - 2016, Benjamin Carl - All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* - All advertising materials mentioning features or use of this software
* must display the following acknowledgment: This product includes software
* developed by Benjamin Carl and other contributors.
* - Neither the name Benjamin Carl nor the names of other contributors
* may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* Please feel free to contact us via e-mail: opensource@clickalicious.de
*
* @category Doozr
* @package Doozr_Base
* @subpackage Doozr_Base_Exception
* @author Benjamin Carl <opensource@clickalicious.de>
* @copyright 2005 - 2016 Benjamin Carl
* @license http://www.opensource.org/licenses/bsd-license.php The BSD License
* @version Git: $Id$
* @link http://clickalicious.github.com/Doozr/
*/
require_once DOOZR_DOCUMENT_ROOT.'Doozr/Base/Exception/Generic.php';
/**
* Doozr - Base - Exception
*
* Simple basic exception class of the Doozr Framework.
*
* @category Doozr
* @package Doozr_Base
* @subpackage Doozr_Base_Exception
* @author Benjamin Carl <opensource@clickalicious.de>
* @copyright 2005 - 2016 Benjamin Carl
* @license http://www.opensource.org/licenses/bsd-license.php The BSD License
* @version Git: $Id$
* @link http://clickalicious.github.com/Doozr/
*/
class Doozr_Base_Exception extends Doozr_Base_Exception_Generic
{
/**
* The type of the exception (is in 99% the className)
*
* @var string
* @access public
*/
public $type;
/**
* The message of the exception
*
* @var string
* @access public
*/
public $message;
/**
* The filename in which the exception was thrown
*
* @var string
* @access public
*/
public $file;
/**
* The line where the exception was thrown
*
* @var int
* @access public
*/
public $line;
/**
* The code of the exception
*
* @var int
* @access public
*/
public $code;
/**
* The last exception if the exception was forwarded
*
* @var Exception
* @access public
*/
public $previous;
/**
* The arguments passed to the last executed method
*
* @var array
* @access public
*/
public $arguments;
/**
* Constructor.
*
* @param string $message Exception-message
* @param int $code Code of the exception
* @param Exception $previous Previous exception thrown - AS_OF: PHP 5.3 introduced !
*
* @author Benjamin Carl <opensource@clickalicious.de>
* @return \Doozr_Base_Exception
* @access public
*/
public function __construct($message = null, $code = 0, Exception $previous = null)
{
// No message set set => throw us again
if (null === $message) {
throw new $this(
sprintf('Exception "%s" without message!', get_class($this))
);
}
parent::__construct($message, $code, $previous);
}
/**
* Generates an unique code for each exception type.
*
* @param string $file The exception-message
* @param int $code The error-code of the exception
*
* @author Benjamin Carl <opensource@clickalicious.de>
* @return string An unique error-code
* @access protected
*/
protected function generateUniqueCode($file, $code)
{
$file = filename($file);
$base = 999;
$base -= floor(sqrt($base * $this->getChecksum($file)) / 1000);
$base = crossfoot($base);
$base = sprintf("%03d", $base);
$base = strrev($base);
$base .= $code;
return $base;
}
/**
* Returns checksum for passed input.
*
* @param string $string The data as string
*
* @author Benjamin Carl <opensource@clickalicious.de>
* @return integer The calculated checksum
* @access protected
*/
protected function getChecksum($string)
{
$length = strlen($string);
$checksum = 0;
for ($i = 0; $i < $length; ++$i) {
$checksum += ord($string{$i}) * $i;
}
return $checksum;
}
/**
* Calculates the nesting level of a passed filename.
*
* @param string $file The file to return nesting level for
*
* @author Benjamin Carl <opensource@clickalicious.de>
* @return integer The nesting level of file
* @access protected
*/
protected function getFileNestingLevel($file)
{
return substr_count($file, DIRECTORY_SEPARATOR);
}
/**
* Setter for type.
*
* @param string $type The type to set
*
* @author Benjamin Carl <opensource@clickalicious.de>
* @return void
* @access public
*/
public function setType($type)
{
$this->type = $type;
}
/**
* Setter for type.
*
* @param string $type The type to set
*
* @author Benjamin Carl <opensource@clickalicious.de>
* @return Doozr_Base_Exception
* @access public
*/
public function type($type)
{
$this->setType($type);
return $this;
}
/**
* Getter for type
*
* @author Benjamin Carl <opensource@clickalicious.de>
* @return string The type
* @access public
*/
public function getType()
{
return $this->type;
}
/**
* Setter for message.
*
* @param string $message The message to set
*
* @author Benjamin Carl <opensource@clickalicious.de>
* @return void
* @access public
*/
public function setMessage($message)
{
$this->message = $message;
}
/**
* Setter for message.
*
* @param string $message The message to set
*
* @author Benjamin Carl <opensource@clickalicious.de>
* @return Doozr_Base_Exception
* @access public
*/
public function message($message)
{
$this->setMessage($message);
return $this;
}
/**
* Setter for file.
*
* @param string $file The filename to set
*
* @author Benjamin Carl <opensource@clickalicious.de>
* @return void
* @access public
*/
public function setFile($file)
{
$this->file = $file;
}
/**
* Setter for file.
*
* @param string $file The filename to set
*
* @author Benjamin Carl <opensource@clickalicious.de>
* @return Doozr_Base_Exception
* @access public
*/
public function file($file)
{
$this->file = $file;
return $this;
}
/**
* Setter for line.
*
* @param integer $line The line to set
*
* @author Benjamin Carl <opensource@clickalicious.de>
* @return void
* @access public
*/
public function setLine($line)
{
$this->line = $line;
}
/**
* Setter for line.
*
* @param integer $line The line to set
*
* @author Benjamin Carl <opensource@clickalicious.de>
* @return Doozr_Base_Exception
* @access public
*/
public function line($line)
{
$this->setLine($line);
return $this;
}
}