framework/main/exceptions/main/class_UnsupportedOperationException.php

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