Registration stub added, naming convention applied, support for PHP code (keep it...

[shipsimu.git] / inc / classes / main / class_BaseFrameworkSystem.php

diff --git a/inc/classes/main/class_BaseFrameworkSystem.php b/inc/classes/main/class_BaseFrameworkSystem.php
index 6b4d81694fe6244d3b8f337363da3113f71f55cc..c1f216eee8f143fe14afa661d16bac5f7944b40d 100644 (file)
--- a/inc/classes/main/class_BaseFrameworkSystem.php
+++ b/inc/classes/main/class_BaseFrameworkSystem.php
@@ -148,6 +148,8 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        const EXCEPTION_INVALID_COMMAND              = 0x031;
        const EXCEPTION_INVALID_CONTROLLER           = 0x032;
        const EXCEPTION_HEADERS_ALREADY_SENT         = 0x033;
+       const EXCEPTION_DEFAUL_CONTROLLER_GONE       = 0x034;
+       const EXCEPTION_CLASS_NOT_FOUND              = 0x035;
 
        /**
         * In the super constructor these system classes shall be ignored or else
@@ -217,8 +219,50 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         */
        public final function __call ($methodName, $args) {
                // Implode all given arguments
-               $argsString = implode("|", $args);
-               if (empty($argsString)) $argsString = "NULL";
+               $argsString = "";
+               if (empty($args)) {
+                       // No arguments
+                       $argsString = "NULL";
+               } elseif (is_array($args)) {
+                       // Some arguments are there
+                       foreach ($args as $arg) {
+                               // Check the type
+                               if (is_bool($arg)) {
+                                       // Boolean!
+                                       if ($arg) $argsString .= "true(bool)"; else $argsString .= "false(bool)";
+                               } elseif (is_int($arg)) {
+                                       // Integer
+                                       $argsString .= $arg."(int)";
+                               } elseif (is_float($arg)) {
+                                       // Floating point
+                                       $argsString .= $arg."(float)";
+                               } elseif ($arg instanceof BaseFramework) {
+                                       // Own object instance
+                                       $argsString .= $arg->__toString()."(Object)";
+                               } elseif (is_object($arg)) {
+                                       // External object
+                                       $argsString .= "unknown object(!)";
+                               } elseif (is_array($arg)) {
+                                       // Array
+                                       $argsString .= "Array(array)";
+                               } elseif (is_string($arg)) {
+                                       // String
+                                       $argsString .= "\"".$arg."\"(string)";
+                               } else {
+                                       // Unknown type (please report!)
+                                       $argsString .= $arg."(unknown!)";
+                               }
+
+                               // Add comma
+                               $argsString .= ", ";
+                       }
+
+                       // Remove last comma
+                       if (substr($argsString, -2, 1) === ",") $argsString = substr($argsString, 0, -2);
+               } else {
+                       // Invalid arguments!
+                       $argsString = sprintf("!INVALID:%s!", $args);
+               }
 
                $this->getDebugInstance()->output(sprintf("[%s::%s] Stub! Args: %s",
                        $this->__toString(),
@@ -257,7 +301,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                                );
 
                                // Debug message
-                               if ((defined('DEBUG_EVAL')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:] Konstruierte PHP-Anweisung: <pre><em>%s</em></pre><br />\n",
+                               if (defined('DEBUG_EVAL')) $this->getDebugInstance()->output(sprintf("[%s:] Constructed PHP command: <pre><em>%s</em></pre><br />\n",
                                        $this->__toString(),
                                        htmlentities($eval)
                                ));
@@ -284,11 +328,6 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                                        $this->setDatabaseInstance($db);
                                }
                        }
-
-                       // Debug output
-                       if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Alle Sub-Systeme sind initialisiert.<br />\n",
-                               $this->__toString()
-                       ));
                }
        }
 
@@ -301,10 +340,6 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         */
        public final function setConfigInstance (FrameworkConfiguration $configInstance) {
                self::$cfgInstance = $configInstance;
-               if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Konfigurations-Handler auf <strong>%s</strong> gesetzt.<br />\n",
-                       $this->__toString(),
-                       $configInstance->__toString()
-               ));
        }
 
        /**
@@ -312,11 +347,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         *
         * @return      $cfhInstance - Configuration instance
         */
-       public final function getConfigInstance () {
-               if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Konfigurations-Handler <strong>%s</strong> angefordert.<br />\n",
-                       $this->__toString(),
-                       self::$cfgInstance->__toString()
-               ));
+       protected final function getConfigInstance () {
                return self::$cfgInstance;
        }
 
@@ -328,10 +359,6 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         */
        public final function setDebugInstance (DebugMiddleware $debugInstance) {
                self::$debug = $debugInstance;
-               if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Debug-Handler auf <strong>%s</strong> gesetzt.<br />\n",
-                       $this->__toString(),
-                       $this->getDebugInstance()->__toString()
-               ));
        }
 
        /**
@@ -351,10 +378,6 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         */
        public final function setWebOutputInstance (OutputStreamer $webInstance) {
                self::$webOutput = $webInstance;
-               if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Web-Handler auf <strong>%s</strong> gesetzt.<br />\n",
-                       $this->__toString(),
-                       $this->getWebOutputInstance()->__toString()
-               ));
        }
 
        /**
@@ -374,9 +397,6 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @return      void
         */
        public final function setDatabaseInstance (DatabaseConnection $dbInstance) {
-               if ((defined('DEBUG_SYSTEM')) && (is_object($dbInstance->getDebugInstance()))) $dbInstance->getDebugInstance()->output(sprintf("[%s:] Datenbankschicht gesetzt.<br />\n",
-                       $dbInstance->__toString()
-               ));
                $this->dbInstance = $dbInstance;
        }
 
@@ -386,9 +406,6 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @return      $realClass The name of the real class (not BaseFrameworkSystem)
         */
        public final function __toString () {
-               if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] __toString() erreicht.<br />\n",
-                       $this->realClass
-               ));
                return $this->realClass;
        }
 
@@ -412,15 +429,8 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @return      void
         */
        public final function createUniqueID () {
-               if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] createUniqueID aufgerufen.<br />\n",
-                       $this->__toString()
-               ));
-
                // Existiert noch keine?
                if (empty($this->uniqueID)) {
-                       if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] createUniqueID erzeugt neue Unique-ID.<br />\n",
-                               $this->__toString()
-                       ));
 
                        // Correct missing class name
                        $corrected = false;
@@ -463,13 +473,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                                        // Abort the loop
                                        break;
                                }
-                       }
-
-                       // Debug message
-                       if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] uniqueID ist auf <strong>%s</strong> gesetzt.<br />\n",
-                               $this->__toString(),
-                               $tempID
-                       ));
+                       } // END - while
 
                        // Apply the new ID
                        $this->setUniqueID($tempID);
@@ -517,12 +521,6 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                // Cast to string
                $uniqueID = (string) $uniqueID;
 
-               // Debug message
-               if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Unique-ID gesetzt auf <u>%s</u>.<br />\n",
-                       $this->__toString(),
-                       $uniqueID
-               ));
-
                // Set the ID number
                $this->uniqueID = $uniqueID;
        }
@@ -533,9 +531,6 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @return      $uniqueID               The unique ID of this class
         */
        public final function getUniqueID () {
-               if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Unique-ID angefordert.<br />\n",
-                       $this->__toString()
-               ));
                return $this->uniqueID;
        }
 
@@ -547,10 +542,6 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        public final function resetUniqueID() {
                // Sweet and simple... ;-)
                $newUniqueID = $this->generateIdNumber();
-               if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Unique-ID zur&uuml;ckgesetzt auf <u>%s</u>.<br />\n",
-                       $this->__toString(),
-                       $newUniqueID
-               ));
                $this->setUniqueID($newUniqueID);
        }
 
@@ -560,9 +551,6 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @return      $objectDescription      The description of this simulation part
         */
        public final function getObjectDescription () {
-               if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] getObjectDescription erreicht.<br />\n",
-                       $this->__toString()
-               ));
                if (isset($this->objectDescription)) {
                        return $this->objectDescription;
                } else {
@@ -578,10 +566,6 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         */
        public final function setObjectDescription ($objectDescription) {
                $this->objectDescription = (String) $objectDescription;
-               if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Teilbeschreibung wird auf <strong>%s</strong> gesetzt.<br />\n",
-                       $this->__toString(),
-                       $this->objectDescription
-               ));
        }
 
        /**
@@ -618,11 +602,6 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @return      boolean The result of comparing both class names
         */
        public final function isClass ($class) {
-               if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] <strong>%s</strong>=<strong>%s</strong>?<br />\n",
-                       $this->__toString(),
-                       $this->__toString(),
-                       $class
-               ));
                return ($this->__toString() == $class);
        }
 
@@ -666,10 +645,6 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 
                // Cast the number
                $value = (float) $value;
-               if (defined('DEBUG_CORE') && is_object($this->getDebugInstance())) $this->getDebugInstance()->output(sprintf("[%s:] <strong>%d</strong> wird umformatiert.<br />\n",
-                       $this->__toString(),
-                       $value
-               ));
 
                // Reformat the US number
                $price = sprintf("%s %s",
@@ -687,9 +662,6 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @return      void
         */
        public final function removeNumberFormaters () {
-               if (defined('DEBUG_CORE') && is_object($this->getDebugInstance())) $this->getDebugInstance()->output(sprintf("[%s:] Zahlenumformatierungszeichen werden entfernt.<br />\n",
-                       $this->__toString()
-               ));
                unset($this->thousands);
                unset($this->decimals);
        }
@@ -700,10 +672,6 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @return      $dbInstance     The database layer instance
         */
        public final function getDatabaseInstance () {
-               if (defined('DEBUG_CORE') && is_object($this->getDebugInstance())) $this->getDebugInstance()->output(sprintf("[%s:] Datenbank-Instanz <u>%s</u> angefordert.<br />\n",
-                       $this->__toString(),
-                       $this->dbInstance
-               ));
                return $this->dbInstance;
        }
 
@@ -806,7 +774,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         *
         * @return      $fileIOInstance An instance to the file I/O sub-system
         */
-       protected final function getFileIOInstance () {
+       protected final function getFileIoInstance () {
                return $this->fileIOInstance;
        }
 
@@ -816,7 +784,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @param       $fileIOInstance An instance to the file I/O sub-system
         * @return      void
         */
-       public final function setFileIOInstance (FileIOHandler $fileIOInstance) {
+       public final function setFileIoInstance (FileIoHandler $fileIOInstance) {
                $this->fileIOInstance = $fileIOInstance;
        }
 
@@ -880,7 +848,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                if ($appInstance->getLanguageInstance() === null) {
                        // Invalid language instance
                        throw new MissingLanguageHandlerException($appInstance, self::EXCEPTION_MISSING_LANGUAGE_HANDLER);
-               } elseif ($appInstance->getFileIOInstance() === null) {
+               } elseif ($appInstance->getFileIoInstance() === null) {
                        // Invalid language instance
                        throw new MissingFileIoHandlerException($appInstance, self::EXCEPTION_MISSING_FILE_IO_HANDLER);
                }
@@ -890,7 +858,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                $eval = sprintf("\$tplEngine = %s::create%s(
        \"%s\",
        \$appInstance->getLanguageInstance(),
-       \$appInstance->getFileIOInstance()
+       \$appInstance->getFileIoInstance()
 );",
                        $this->getConfigInstance()->readConfig("tpl_engine"),
                        $this->getConfigInstance()->readConfig("tpl_engine"),
@@ -899,7 +867,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 
                // Debug message
                if ((!is_null($this->getDebugInstance())) && (defined('DEBUG_EVAL'))) {
-                       $this->getDebugInstance()->output(sprintf("[%s:] Konstruierte PHP-Anweisung: <pre><em>%s</em></pre><br />\n",
+                       $this->getDebugInstance()->output(sprintf("[%s:] Constructed PHP command: <pre><em>%s</em></pre><br />\n",
                                $this->__toString(),
                                htmlentities($eval)
                        ));
@@ -920,6 +888,19 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                // Return the prepared instance
                return $tplEngine;
        }
+
+       /**
+        * Debugs this instance by putting out it's full content
+        *
+        * @return      void
+        */
+       public final function debugInstance () {
+               // Generate the output
+               $content = "<pre>".trim(print_r($this, true))."</pre>";
+
+               // Output it
+               ApplicationEntryPoint::app_die("<strong>Debug output:</strong>".$content);
+       }
 }
 
 // [EOF]