inc/main/exceptions/main/class_UnsupportedOperationException.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Generic;
   4
   5 // Import framework stuff
   6 use CoreFramework\Generic\FrameworkInterface;
   7
   8 /**
   9  * An exception thrown when an unfinished method is called or when it should
  10  * never be called.
  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 UnsupportedOperationException extends FrameworkException {
  32         /**
  33          * The constructor
  34          *
  35          * @param       $classArray             Array holding the exception data
  36          * @param       $code                   Code number for the exception
  37          * @return      void
  38          */
  39         public function __construct (array $classArray, $code) {
  40                 // Init extra class name
  41                 $extraClassName = '';
  42
  43                 // Do we have an extra instance?
  44                 if ((isset($classArray[2])) && ($classArray[2] instanceof FrameworkInterface)) {
  45                         // Get the class name
  46                         $extraClassName = $classArray[2]->__toString();
  47                 } // END - if
  48
  49                 // Add a message around the missing class
  50                 $message = sprintf('[%s:%d] Method <u>%s()</u> is unsupported or should not be called. extraInstance=%s',
  51                         $classArray[0]->__toString(),
  52                         $this->getLine(),
  53                         $classArray[1],
  54                         $extraClassName
  55                 );
  56
  57                 // Call parent constructor
  58                 parent::__construct($message, $code);
  59         }
  60
  61 }