From: Roland Häder <roland@mxchange.org>
Date: Fri, 18 May 2012 18:35:59 +0000 (+0000)
Subject: Added method unsetConfigEntry()
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=1f5f8021cedb431b687a30e4b19186339c00e0b9;p=core.git

Added method unsetConfigEntry()
---

diff --git a/inc/config/class_FrameworkConfiguration.php b/inc/config/class_FrameworkConfiguration.php
index 38ccf6e5..6743ab4b 100644
--- a/inc/config/class_FrameworkConfiguration.php
+++ b/inc/config/class_FrameworkConfiguration.php
@@ -119,55 +119,73 @@ 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) {
+	public function getConfigEntry ($configEntry) {
 		// Cast to string
-		$cfgEntry = (string) $cfgEntry;
+		$configEntry = (string) $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 = (string) $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;
+		$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	$configKey	Configuration entry to unset
+	 * @return	void
+	 * @throws	NoConfigEntryException	If a configuration element was not found
+	 */
+	public final function unsetConfigEntry ($configKey) {
+		// 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[$configKey]);
+	}
+
 	/**
 	 * Detects the server address (SERVER_ADDR) and set it in configuration
 	 *