framework/main/exceptions/main/class_MissingArrayElementsException.php

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