X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=inc%2Fconfig%2Fclass_FrameworkConfiguration.php;h=25125e5fdb4a61128fa05f81c4232a26562589f6;hb=ed7ca64368d512574efeda0f6b8d8e970d41aa1d;hp=50a4ac18a35d588fe162e4b75c0f17f140c1019e;hpb=b848cab53db89342f0a854a00be91cadbcff2967;p=shipsimu.git

diff --git a/inc/config/class_FrameworkConfiguration.php b/inc/config/class_FrameworkConfiguration.php
index 50a4ac1..25125e5 100644
--- a/inc/config/class_FrameworkConfiguration.php
+++ b/inc/config/class_FrameworkConfiguration.php
@@ -8,7 +8,7 @@
  * @see			ClassLoader
  * @author		Roland Haeder <webmaster@ship-simu.org>
  * @version		0.0.0
- * @copyright	Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @copyright	Copyright (c) 2007, 2008 Roland Haeder, this is free software
  * @license		GNU GPL 3.0 or any newer version
  * @link		http://www.ship-simu.org
  *
@@ -39,11 +39,13 @@ class FrameworkConfiguration implements Registerable {
 	private static $cfgInstance = null;
 
 	// Some constants for the configuration system
-	const EXCEPTION_CONFIG_ENTRY_IS_EMPTY      = 0x040;
-	const EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND = 0x041;
+	const EXCEPTION_CONFIG_ENTRY_IS_EMPTY      = 0x130;
+	const EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND = 0x131;
 
 	/**
 	 * Protected constructor
+	 *
+	 * @return	void
 	 */
 	protected function __construct () {
 		// Empty for now
@@ -51,6 +53,9 @@ class FrameworkConfiguration implements Registerable {
 
 	/**
 	 * "Create" a configuration instance
+	 *
+	 * @param	$enableDebug	Wether enable debug mode (default: off)
+	 * @return	$cfgInstance	An instance of this configuration class
 	 */
 	public final static function createFrameworkConfiguration ($enableDebug = false) {
 		/**
@@ -58,7 +63,7 @@ class FrameworkConfiguration implements Registerable {
 		 * through the initial configuration.
 		 */
 		if (is_null(self::$cfgInstance))  {
-			// CFG: DEBUG-LEVEL
+			// CFG: ERROR-REPORTING
 			@error_reporting(E_ALL | E_STRICT);
 
 			/**
@@ -99,7 +104,7 @@ class FrameworkConfiguration implements Registerable {
 		// At least 5.1.0 is required for this!
 		if (version_compare(phpversion(), "5.1.0")) {
 			@date_default_timezone_set($zone);
-		}
+		} // END - if
 	}
 
 	/**
@@ -136,12 +141,12 @@ class FrameworkConfiguration implements Registerable {
 						// Base path is already added
 						$fqfn = $inc;
 					}
-				}
+				} // END - if
 
 				// Include them all here
 				require($fqfn);
 			}
-		}
+		} // END - if
 	}
 
 	/**
@@ -221,7 +226,7 @@ class FrameworkConfiguration implements Registerable {
 		// Debug message
 		if ((defined('DEBUG_CONFIG')) || (defined('DEBUG_ALL'))) {
 			echo "[".__METHOD__."] Configuration entry ".$cfgEntry." requested.<br />\n";
-		}
+		} // END - if
 
 		// Return the requested value
 		return $this->config[$cfgEntry];
@@ -244,7 +249,7 @@ class FrameworkConfiguration implements Registerable {
 		if (empty($cfgEntry)) {
 			// Entry is empty
 			throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY);
-		}
+		} // END - if
 
 		// Set the configuration value
 		$this->config[$cfgEntry] = $cfgValue;