X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fconfig%2Fclass_FrameworkConfiguration.php;h=914d13a183b397e0d77b573176932c384be6dd50;hp=f37194d94aaa8abcbf9928cb5782cfce6985646b;hb=202aa130a32c1cd218f883b06c32827a799c9497;hpb=3b369c267715db8baefd28b85375406946270ebd

diff --git a/inc/config/class_FrameworkConfiguration.php b/inc/config/class_FrameworkConfiguration.php
index f37194d9..914d13a1 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, 2009 Core Developer Team
+ * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
  * @license		GNU GPL 3.0 or any newer version
  * @link		http://www.ship-simu.org
  *
@@ -36,7 +36,7 @@ class FrameworkConfiguration implements Registerable {
 	/**
 	 * The configuration instance itself
 	 */
-	private static $configInstance = null;
+	private static $configInstance = NULL;
 
 	// Some constants for the configuration system
 	const EXCEPTION_CONFIG_ENTRY_IS_EMPTY      = 0x130;
@@ -54,31 +54,46 @@ class FrameworkConfiguration implements Registerable {
 	/**
 	 * Compatiblity method to return this class' name
 	 *
-	 * @return	__CLASS__		This class' name
+	 * @return	__CLASS__	This class' name
 	 */
 	public function __toString () {
 		return get_class($this);
 	}
 
 	/**
-	 * Getter for an instance of this class
+	 * Getter for a singleton instance of this class
 	 *
-	 * @return	$configInstance	An instance of this class
+	 * @return	$configInstance		A singleton instance of this class
 	 */
-	public final static function getInstance () {
+	public static final function getSelfInstance () {
 		// is the instance there?
 		if (is_null(self::$configInstance))  {
 			// Create a config instance
 			self::$configInstance = new FrameworkConfiguration();
 		} // END - if
 
+		// Return singleton instance
 		return self::$configInstance;
 	}
 
+	/**
+	 * Converts dashes to underscores, e.g. useable for configuration entries
+	 *
+	 * @param	$str	The string with maybe dashes inside
+	 * @return	$str	The converted string with no dashed, but underscores
+	 */
+	private final function convertDashesToUnderscores ($str) {
+		// Convert them all
+		$str = str_replace('-', '_', $str);
+
+		// Return converted string
+		return $str;
+	}
+
 	/**
 	 * Setter for default time zone (must be correct!)
 	 *
-	 * @param		$zone	The time-zone string (e.g. Europe/Berlin)
+	 * @param	$zone	The time-zone string (e.g. Europe/Berlin)
 	 * @return	void
 	 */
 	public final function setDefaultTimezone ($zone) {
@@ -90,6 +105,9 @@ class FrameworkConfiguration implements Registerable {
 
 	/**
 	 * Setter for runtime magic quotes
+	 *
+	 * @param	$enableQuotes	Whether enable magic runtime quotes (should be disabled for security reasons)
+	 * @return	void
 	 */
 	public final function setMagicQuotesRuntime ($enableQuotes) {
 		// Cast it to boolean
@@ -100,10 +118,10 @@ class FrameworkConfiguration implements Registerable {
 	}
 
 	/**
-	 * Checks wether the given configuration entry is set
+	 * Checks whether the given configuration entry is set
 	 *
 	 * @param	$configEntry	The configuration entry we shall check
-	 * @return	$isset			Wether the given configuration entry is set
+	 * @return	$isset			Whether the given configuration entry is set
 	 */
 	protected function isConfigurationEntrySet ($configEntry) {
 		// Is it set?
@@ -116,55 +134,77 @@ class FrameworkConfiguration implements Registerable {
 	/**
 	 * Read a configuration element.
 	 *
-	 * @param	$cfgEntry	The configuration element
-	 * @return	$cfgValue	The fetched configuration value
-	 * @throws	ConfigEntryIsEmptyException		If $cfgEntry is empty
-	 * @throws	NoConfigEntryException	If a configuration element
-	 *											was not found
+	 * @param	$configEntry	The configuration element
+	 * @return	$configValue	The fetched configuration value
+	 * @throws	ConfigEntryIsEmptyException		If $configEntry is empty
+	 * @throws	NoConfigEntryException	If a configuration element was not found
 	 */
-	public function getConfigEntry ($cfgEntry) {
-		// Cast to string
-		$cfgEntry = (string) $cfgEntry;
+	public function getConfigEntry ($configEntry) {
+		// Convert dashes to underscore
+		$configEntry = $this->convertDashesToUnderscores($configEntry);
 
 		// Is a valid configuration entry provided?
-		if (empty($cfgEntry)) {
+		if (empty($configEntry)) {
 			// Entry is empty
 			throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY);
-		} elseif (!$this->isConfigurationEntrySet($cfgEntry)) {
+		} elseif (!$this->isConfigurationEntrySet($configEntry)) {
 			// Entry was not found!
-			throw new NoConfigEntryException(array(__CLASS__, $cfgEntry), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND);
+			throw new NoConfigEntryException(array(__CLASS__, $configEntry), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND);
 		}
 
 		// Return the requested value
-		return $this->config[$cfgEntry];
+		return $this->config[$configEntry];
 	}
 
 	/**
-	 * Set a configuration entry.
+	 * Set a configuration entry
 	 *
-	 * @param	$cfgEntry	The configuration entry we want to add/change
-	 * @param	$cfgValue	The configuration value we want to set
+	 * @param	$configEntry	The configuration entry we want to add/change
+	 * @param	$configValue	The configuration value we want to set
 	 * @return	void
-	 * @throws	ConfigEntryIsEmptyException	If $cfgEntry is empty
+	 * @throws	ConfigEntryIsEmptyException		If $configEntry is empty
 	 */
-	public final function setConfigEntry ($cfgEntry, $cfgValue) {
+	public final function setConfigEntry ($configEntry, $configValue) {
 		// Cast to string
-		$cfgEntry = (string) $cfgEntry;
-		$cfgValue = (string) $cfgValue;
+		$configEntry = $this->convertDashesToUnderscores($configEntry);
+		$configValue = (string) $configValue;
 
 		// Is a valid configuration entry provided?
-		if (empty($cfgEntry)) {
+		if (empty($configEntry)) {
 			// Entry is empty
 			throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY);
 		} // END - if
 
 		// Set the configuration value
-		$this->config[$cfgEntry] = $cfgValue;
+		//* NOISY-DEBUG: */ print(__METHOD__ . ':configEntry=' . $configEntry . ',configValue=' . $configValue . PHP_EOL);
+		$this->config[$configEntry] = $configValue;
 
 		// Resort the array
 		ksort($this->config);
 	}
 
+	/**
+	 * Unset a configuration entry, the entry must be there or else an
+	 * exception is thrown.
+	 *
+	 * @param	$configEntry	Configuration entry to unset
+	 * @return	void
+	 * @throws	NoConfigEntryException	If a configuration element was not found
+	 */
+	public final function unsetConfigEntry ($configEntry) {
+		// Convert dashes to underscore
+		$configEntry = $this->convertDashesToUnderscores($configEntry);
+
+		// Is the configuration entry there?
+		if (!$this->isConfigurationEntrySet($configEntry)) {
+			// Entry was not found!
+			throw new NoConfigEntryException(array(__CLASS__, $configEntry), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND);
+		} // END - if
+
+		// Unset it
+		unset($this->config[$configEntry]);
+	}
+
 	/**
 	 * Detects the server address (SERVER_ADDR) and set it in configuration
 	 *
@@ -217,7 +257,7 @@ class FrameworkConfiguration implements Registerable {
 	 */
 	public function detectHttpSecured () {
 		// Default is null
-		$https = null;
+		$https = NULL;
 
 		// Is HTTPS set?
 		if ($this->isHttpSecured()) {
@@ -230,9 +270,9 @@ class FrameworkConfiguration implements Registerable {
 	}
 
 	/**
-	 * Checks wether HTTPS is set in $_SERVER
+	 * Checks whether HTTPS is set in $_SERVER
 	 *
-	 * @return $isset	Wether HTTPS is set
+	 * @return $isset	Whether HTTPS is set
 	 */
 	public function isHttpSecured () {
 		return (isset($_SERVER['HTTPS']));
@@ -318,7 +358,26 @@ class FrameworkConfiguration implements Registerable {
 	public function hashCode () {
 		return crc32($this->__toString());
 	}
+
+	/**
+	 * Checks whether an object equals this object. You should overwrite this
+	 * method to implement own equality checks
+	 *
+	 * @param	$objectInstance		An instance of a FrameworkInterface object
+	 * @return	$equals				Whether both objects equals
+	 */
+	public function equals (FrameworkInterface $objectInstance) {
+		// Now test it
+		$equals = ((
+			$this->__toString() == $objectInstance->__toString()
+		) && (
+			$this->hashCode() == $objectInstance->hashCode()
+		));
+
+		// Return the result
+		return $equals;
+	}
 }
 
-//
+// [EOF]
 ?>