X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fclass_BaseFrameworkSystem.php;h=0d8213210adf2000e0592850a8902b8258cf1755;hb=f6dd835d8cf21f82d67840b2829871638fca721b;hp=6b4d81694fe6244d3b8f337363da3113f71f55cc;hpb=b912eda46059527fc0475e043944c3ebff47fbcd;p=shipsimu.git

diff --git a/inc/classes/main/class_BaseFrameworkSystem.php b/inc/classes/main/class_BaseFrameworkSystem.php
index 6b4d816..0d82132 100644
--- a/inc/classes/main/class_BaseFrameworkSystem.php
+++ b/inc/classes/main/class_BaseFrameworkSystem.php
@@ -148,6 +148,9 @@ 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;
+	const EXCEPTION_REQUIRED_INTERFACE_MISSING   = 0x036;
 
 	/**
 	 * In the super constructor these system classes shall be ignored or else
@@ -217,8 +220,53 @@ 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 BaseFrameworkSystem) {
+					// 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)";
+				} elseif (is_null($arg)) {
+					// Null
+					$argsString .= "(null)";
+				} 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(),
@@ -244,20 +292,20 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 			// Initialize debug instance
 			if (is_null($this->getDebugInstance())) {
 				// Set the debug output system if it is not debug class ;)
-				$this->setDebugInstance(DebugMiddleware::createDebugMiddleware($this->getConfigInstance()->readConfig("debug_engine")));
+				$this->setDebugInstance(DebugMiddleware::createDebugMiddleware($this->getConfigInstance()->readConfig('debug_engine')));
 			}
 
 			// Initialize web instance
 			if (is_null($this->getWebOutputInstance())) {
 				// Generate the eval() command
 				$eval = sprintf("\$this->setWebOutputInstance(%s::create%s(\"%s\"));",
-					$this->getConfigInstance()->readConfig("web_engine"),
-					$this->getConfigInstance()->readConfig("web_engine"),
-					$this->getConfigInstance()->readConfig("web_content_type")
+					$this->getConfigInstance()->readConfig('web_engine'),
+					$this->getConfigInstance()->readConfig('web_engine'),
+					$this->getConfigInstance()->readConfig('web_content_type')
 				);
 
 				// 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)
 				));
@@ -271,7 +319,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 				// Set the compressor channel
 				$this->setCompressorChannel(CompressorChannel::createCompressorChannel(sprintf("%s%s",
 					PATH,
-					$this->getConfigInstance()->readConfig("compressor_base_path")
+					$this->getConfigInstance()->readConfig('compressor_base_path')
 				)));
 			}
 
@@ -284,11 +332,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 +344,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 +351,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 +363,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 +382,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 +401,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 +410,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 +433,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 +477,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 +525,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 +535,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 +546,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 +555,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 +570,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 +606,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);
 	}
 
@@ -649,10 +632,10 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 	 * Formats computer generated price values into human-understandable formats
 	 * with thousand and decimal seperators.
 	 *
-	 * @param		$value	The in computer format value for a price
-	 * @param		$currency	The currency symbol (use HTML-valid characters!)
-	 * @param		$decNum	Number of decimals after commata
-	 * @return	$price	The for the current language formated price string
+	 * @param	$value		The in computer format value for a price
+	 * @param	$currency	The currency symbol (use HTML-valid characters!)
+	 * @param	$decNum		Number of decimals after commata
+	 * @return	$price		The for the current language formated price string
 	 * @throws	MissingDecimalsThousandsSeperatorException	If decimals or
 	 *												thousands seperator
 	 *												is missing
@@ -666,10 +649,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 +666,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 +676,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 +778,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 +788,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;
 	}
 
@@ -871,16 +843,16 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 		// Generate FQFN for all application templates
 		$fqfn = sprintf("%s%s/%s/%s",
 			PATH,
-			$this->getConfigInstance()->readConfig("application_path"),
+			$this->getConfigInstance()->readConfig('application_path'),
 			strtolower($appInstance->getAppShortName()),
-			$this->getConfigInstance()->readConfig("tpl_base_path")
+			$this->getConfigInstance()->readConfig('tpl_base_path')
 		);
 
 		// Are both instances set?
 		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,16 +862,16 @@ 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"),
+			$this->getConfigInstance()->readConfig('tpl_engine'),
+			$this->getConfigInstance()->readConfig('tpl_engine'),
 			$fqfn
 		);
 
 		// 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 +892,85 @@ 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 = sprintf("<pre>%s</pre>",
+			trim(print_r($this, true))
+		);
+
+		// Output it
+		ApplicationEntryPoint::app_die(sprintf("<strong>%s debug output:</strong>%s", $this->__toString(), $content));
+	}
+
+	/**
+	 * Output a partial stub message for the caller method
+	 *
+	 * @param	$message	An optional message to display
+	 * @return	void
+	 */
+	protected function partialStub ($message = "") {
+		// Get the backtrace
+		$backtrace = debug_backtrace();
+
+		// Generate the class::method string
+		$methodName = "UnknownClass::unknownMethod";
+		if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) {
+			$methodName = $backtrace[1]['class']."::".$backtrace[1]['function'];
+		}
+
+		// Construct the full message
+		$stubMessage = sprintf("[%s:] Partial stub!",
+			$methodName
+		);
+
+		// Is the extra message given?
+		if (!empty($message)) {
+			// Then add it as well
+			$stubMessage .= sprintf(" Message: <u>%s</u>", $message);
+		}
+
+		// Debug instance is there?
+		if (!is_null($this->getDebugInstance())) {
+			// Output stub message
+			$this->getDebugInstance()->output($stubMessage);
+		} else {
+			// Trigger an error
+			trigger_error($stubMessage."<br />\n");
+		}
+	}
+
+	/**
+	 * Converts e.g. a command from URL to a valid class by keeping out bad characters
+	 *
+	 * @param	$str		The string, what ever it is needs to be converted
+	 * @return	$className	Generated class name
+	 */
+	public function convertToClassName ($str) {
+		$className = "";
+		foreach (explode("_", $str) as $strPart) {
+			$className .= ucfirst(strtolower($strPart));
+		}
+		return $className;
+	}
+
+	/**
+	 * Outputs a debug backtrace and stops further script execution
+	 *
+	 * @return	void
+	 */
+	public function debugBacktrace () {
+		// Sorry, there is no other way getting this nice backtrace
+		print "<pre>\n";
+		debug_print_backtrace();
+		print "</pre>";
+		exit;
+	}
 }
 
 // [EOF]