Continued with unit tests:
[core.git] / framework / main / exceptions / main / class_NullPointerException.php
1 <?php
2 // Own namespace
3 namespace CoreFramework\Generic;
4
5 // Import framework stuff
6 use CoreFramework\Generic\FrameworkException;
7 use CoreFramework\Generic\FrameworkInterface;
8
9 /**
10  * An exception thrown when an object instance is null
11  *
12  * @author              Roland Haeder <webmaster@shipsimu.org>
13  * @version             0.0.0
14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
15  * @license             GNU GPL 3.0 or any newer version
16  * @link                http://www.shipsimu.org
17  * 
18  * This program is free software: you can redistribute it and/or modify
19  * it under the terms of the GNU General Public License as published by
20  * the Free Software Foundation, either version 3 of the License, or
21  * (at your option) any later version.
22  *
23  * This program is distributed in the hope that it will be useful,
24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
26  * GNU General Public License for more details.
27  *
28  * You should have received a copy of the GNU General Public License
29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
30  */
31 class NullPointerException extends FrameworkException {
32         /**
33          * The constructor
34          *
35          * @param       $class  Class throwing this exception
36          * @param       $code   Code number for the exception
37          * @return      void
38          */
39         public function __construct (FrameworkInterface $class = NULL, $code) {
40                 // Is the instance set?
41                 if (is_null($class)) {
42                         // Add a message around the missing class
43                         $message = sprintf('[unknown:%d] An object instance is set to <em>null</em>.',
44                                 $this->getLine()
45                         );
46                 } else {
47                         // Add a message around the missing class
48                         $message = sprintf('[%s:%d] An object instance is set to <em>null</em>.',
49                                 $class->__toString(),
50                                 $this->getLine()
51                         );
52                 }
53
54                 // Call parent constructor
55                 parent::__construct($message, $code);
56         }
57
58 }