X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;ds=sidebyside;f=inc%2Fclasses%2Fmain%2Fclass_BaseFrameworkSystem.php;h=9db30498b2b1fb6dd8ded9e163ca2b124fb06069;hb=a1581e4149e08719d2520fab502971bfd05fddb6;hp=8ac8d31fb01a35b584214311eea9a8538ec7537a;hpb=090cdbc7b32bb76588126b2591e4a8d18d855f0c;p=shipsimu.git

diff --git a/inc/classes/main/class_BaseFrameworkSystem.php b/inc/classes/main/class_BaseFrameworkSystem.php
index 8ac8d31..9db3049 100644
--- a/inc/classes/main/class_BaseFrameworkSystem.php
+++ b/inc/classes/main/class_BaseFrameworkSystem.php
@@ -4,10 +4,10 @@
  * class handles saving of games etc.
  *
  * @author		Roland Haeder <webmaster@ship-simu.org>
- * @version		0.3.0
+ * @version		0.0.0
  * @copyright	Copyright(c) 2007, 2008 Roland Haeder, this is free software
  * @license		GNU GPL 3.0 or any newer version
- * @link		http://www.mxchange.org
+ * @link		http://www.ship-simu.org
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -20,7 +20,7 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 	/**
@@ -53,6 +53,11 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 	 */
 	private $dbInstance  = null;
 
+	/**
+	 * Instance to an application helper class
+	 */
+	private $applicationInstance = null;
+
 	/**
 	 * The real class name
 	 */
@@ -61,7 +66,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 	/**
 	 * A human-readable description for this simulator part
 	 */
-	private $partDescr      = "Namenlose Framework-Einheit";
+	private $objectDescription      = "Namenlose Framework-Einheit";
 
 	/**
 	 * The unique ID string for identifying all type of classes
@@ -139,6 +144,10 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 	const EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED  = 0x02d;
 	const EXCEPTION_MISSING_LANGUAGE_HANDLER     = 0x02e;
 	const EXCEPTION_MISSING_FILE_IO_HANDLER      = 0x02f;
+	const EXCEPTION_MISSING_ELEMENT              = 0x030;
+	const EXCEPTION_INVALID_COMMAND              = 0x031;
+	const EXCEPTION_INVALID_CONTROLLER           = 0x032;
+	const EXCEPTION_HEADERS_ALREADY_SENT         = 0x033;
 
 	/**
 	 * In the super constructor these system classes shall be ignored or else
@@ -149,16 +158,16 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 	 *--------------------------------------------------------------------*
 	 */
 	private $systemClasses = array(
-		"DebugMiddleware",			// Debug middleware output sub-system
-		"DebugWebOutput",			// Debug web output sub-system
-		"DebugConsoleOutput",		// Debug console output sub-system
-		"DebugErrorLogOutput",		// Debug error_log() output sub-system
-		"CompressorChannel",		// Compressor sub-system
+		"DebugMiddleware",				// Debug middleware output sub-system
+		"DebugWebOutput",				// Debug web output sub-system
+		"DebugConsoleOutput",			// Debug console output sub-system
+		"DebugErrorLogOutput",			// Debug error_log() output sub-system
+		"CompressorChannel",			// Compressor sub-system
 		"FrameworkDirectoryPointer",	// Directory handler sub-system
-		"NullCompressor",			// Null compressor
-		"Bzip2Compressor",			// BZIP2 compressor
-		"GzipCompressor",			// GZIP compressor
-		"WebOutput",				// Web output sub-system
+		"NullCompressor",				// Null compressor
+		"Bzip2Compressor",				// BZIP2 compressor
+		"GzipCompressor",				// GZIP compressor
+		"WebOutput",					// Web output sub-system
 	);
 
 	/**
@@ -166,9 +175,12 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 	 *
 	 * @return	void
 	 */
-	private function __construct ($class) {
+	protected function __construct ($class) {
 		// Set real class
 		$this->setRealClass($class);
+
+		// Init this instance
+		$this->initInstance($class);
 	}
 
 	/**
@@ -187,7 +199,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 			}
 
 			// Destroy all informations about this class but keep some text about it alive
-			$this->setPartDescr(sprintf("Entferntes Objekt <em>%s</em>", $this->__toString()));
+			$this->setObjectDescription(sprintf("Entferntes Objekt <em>%s</em>", $this->__toString()));
 			$this->setRealClass("DestructedObject");
 			$this->resetUniqueID();
 		} elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
@@ -219,14 +231,11 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 	}
 
 	/**
-	 * Public constructor (for initializing things, etc.)
+	 * Initializes the instance
 	 *
 	 * @return	void
 	 */
-	public function constructor ($class) {
-		// Call constructor
-		$this->__construct($class);
-
+	public function initInstance ($class) {
 		// Get the current (singleton) configuration instance
 		$this->setConfigInstance(FrameworkConfiguration::createFrameworkConfiguration());
 
@@ -248,7 +257,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)
 				));
@@ -275,27 +284,18 @@ 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()
-			));
 		}
 	}
 
 	/**
 	 * Setter for language instance
 	 *
-	 * @param		$configInstance	The configuration instance which shall
+	 * @param	$configInstance	The configuration instance which shall
 	 *							be FrameworkConfiguration
 	 * @return	void
 	 */
 	public final function setConfigInstance (FrameworkConfiguration $configInstance) {
-		$this->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()
-		));
+		self::$cfgInstance = $configInstance;
 	}
 
 	/**
@@ -304,11 +304,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(),
-			$this->cfgInstance->__toString()
-		));
-		return $this->cfgInstance;
+		return self::$cfgInstance;
 	}
 
 	/**
@@ -319,10 +315,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()
-		));
 	}
 
 	/**
@@ -342,10 +334,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()
-		));
 	}
 
 	/**
@@ -365,9 +353,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;
 	}
 
@@ -377,9 +362,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;
 	}
 
@@ -403,15 +385,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;
@@ -454,13 +429,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);
@@ -489,7 +458,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 			$this->__toString(),
 			md5(sprintf("%s:%s:%s:%s:%s:%s",
 				$this->__toString(),
-				$this->getPartDescr(),
+				$this->getObjectDescription(),
 				time(),
 				getenv('REMOTE_ADDR'),
 				getenv('SERVER_ADDR'),
@@ -508,12 +477,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;
 	}
@@ -524,9 +487,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;
 	}
 
@@ -538,24 +498,17 @@ 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);
 	}
 
 	/**
 	 * Getter for simulator description
 	 *
-	 * @return	$partDescr	The description of this simulation part
+	 * @return	$objectDescription	The description of this simulation part
 	 */
-	public final function getPartDescr () {
-		if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] getPartDescr erreicht.<br />\n",
-			$this->__toString()
-		));
-		if (isset($this->partDescr)) {
-			return $this->partDescr;
+	public final function getObjectDescription () {
+		if (isset($this->objectDescription)) {
+			return $this->objectDescription;
 		} else {
 			return null;
 		}
@@ -564,15 +517,11 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 	/**
 	 * Setter for simulation part description
 	 *
-	 * @param		$partDescr 	The description as string for this simulation part
+	 * @param		$objectDescription 	The description as string for this simulation part
 	 * @return	void
 	 */
-	public final function setPartDescr ($partDescr) {
-		$this->partDescr = (String) $partDescr;
-		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->partDescr
-		));
+	public final function setObjectDescription ($objectDescription) {
+		$this->objectDescription = (String) $objectDescription;
 	}
 
 	/**
@@ -597,7 +546,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 			(
 				$this->__toString()   == $itemInstance->__toString()
 			) && (
-				$this->getPartDescr() == $itemInstance->getPartDescr()
+				$this->getObjectDescription() == $itemInstance->getObjectDescription()
 			)
 		);
 	}
@@ -609,11 +558,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);
 	}
 
@@ -657,10 +601,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",
@@ -678,9 +618,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);
 	}
@@ -691,10 +628,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;
 	}
 
@@ -811,11 +744,31 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 		$this->fileIOInstance = $fileIOInstance;
 	}
 
+	/**
+	 * Protected getter for a manageable application helper class
+	 *
+	 * @return	$applicationInstance	An instance of a manageable application helper class
+	 */
+	protected final function getApplicationInstance () {
+		return $this->applicationInstance;
+	}
+
+	/**
+	 * Setter for a manageable application helper class
+	 *
+	 * @param	$applicationInstance	An instance of a manageable application helper class
+	 * @return	void
+	 */
+	public final function setApplicationInstance (ManageableApplication $applicationInstance) {
+		$this->applicationInstance = $applicationInstance;
+	}
+
 	/**
 	 * Prepare the template engine (TemplateEngine by default) for a given
 	 * application helper instance (ApplicationHelper by default).
 	 *
-	 * @param		$appInstance			An application helper instance
+	 * @param		$appInstance			An application helper instance or
+	 *										null if we shall use the default
 	 * @return		$tplEngine				The template engine instance
 	 * @throws		NullPointerException	If the template engine could not
 	 *										be initialized
@@ -823,8 +776,22 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 	 * 										unsupported template engine
 	 * @throws		MissingLanguageHandlerException	If the language sub-system
 	 * 										is not yet initialized
-	 */
-	protected function prepareTemplateEngine (BaseFrameworkSystem $appInstance) {
+	 * @throws		NullPointerException	If the discovered application
+	 *										instance is still null
+	 */
+	protected function prepareTemplateEngine (BaseFrameworkSystem $appInstance=null) {
+		// Is the application instance set?
+		if (is_null($appInstance)) {
+			// Get the current instance
+			$appInstance = $this->getApplicationInstance();
+
+			// Still null?
+			if (is_null($appInstance)) {
+				// Thrown an exception
+				throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
+			}
+		}
+
 		// Generate FQFN for all application templates
 		$fqfn = sprintf("%s%s/%s/%s",
 			PATH,
@@ -856,7 +823,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)
 			));
@@ -877,6 +844,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]