Extra but optional instance now supported in UnsupportedOperationException
[core.git] / inc / classes / exceptions / main / class_UnsupportedOperationException.php
1 <?php
2 /**
3  * An exception thrown when an unfinished method is called or when it should
4  * never be called.
5  *
6  * @author              Roland Haeder <webmaster@ship-simu.org>
7  * @version             0.0.0
8  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
9  * @license             GNU GPL 3.0 or any newer version
10  * @link                http://www.ship-simu.org
11  *
12  * This program is free software: you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation, either version 3 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
24  */
25 class UnsupportedOperationException extends FrameworkException {
26         /**
27          * The constructor
28          *
29          * @param       $classArray             Array holding the exception data
30          * @param       $code                   Code number for the exception
31          * @return      void
32          */
33         public function __construct (array $classArray, $code) {
34                 // Init extra class name
35                 $extraClassName = '';
36
37                 // Do we have an extra instance?
38                 if ((isset($classArray[2])) && ($classArray[2] instanceof FrameworkInterface)) {
39                         // Get the class name
40                         $extraClassName = $classArray[2]->__toString();
41                 } // END - if
42
43                 // Add a message around the missing class
44                 $message = sprintf("[%s:%d] Method <u>%s()</u> is unsupported or should not be called. extraInstance=%s",
45                         $classArray[0]->__toString(),
46                         $this->getLine(),
47                         $classArray[1],
48                         $extraClassName
49                 );
50
51                 // Call parent constructor
52                 parent::__construct($message, $code);
53         }
54 }
55
56 // [EOF]
57 ?>