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