X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=framework%2Fconfig%2Fclass_FrameworkConfiguration.php;h=deb78d770dc245d4e8f913cfa287a5c1c7f33533;hp=7342fb42156a39cf37d9da6ee3eebdd52d11614d;hb=HEAD;hpb=a60894f1d6ef33613d2d0351075aa07aa257f304

diff --git a/framework/config/class_FrameworkConfiguration.php b/framework/config/class_FrameworkConfiguration.php
index 7342fb42..98dd71b9 100644
--- a/framework/config/class_FrameworkConfiguration.php
+++ b/framework/config/class_FrameworkConfiguration.php
@@ -4,18 +4,18 @@
 namespace Org\Mxchange\CoreFramework\Configuration;
 
 // Import framework stuff
+use Org\Mxchange\CoreFramework\Configuration\NoConfigEntryException;
 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
-use Org\Mxchange\CoreFramework\Generic\NullPointerException;
 use Org\Mxchange\CoreFramework\Generic\UnsupportedOperationException;
-use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
 use Org\Mxchange\CoreFramework\Registry\Registerable;
-use Org\Mxchange\CoreFramework\String\Utils\StringUtils;
+use Org\Mxchange\CoreFramework\Utils\Strings\StringUtils;
 
 // Import SPL stuff
 use \InvalidArgumentException;
+use \UnexpectedValueException;
 
 /**
- * A class for the configuration stuff implemented in a singleton design paddern
+ * A class for the configuration stuff implemented in a singleton design pattern
  *
  * NOTE: We cannot put this in framework/main/ because it would be loaded (again) in
  * class loader. See framework/loader/class_ClassLoader.php for instance
@@ -23,7 +23,7 @@ use \InvalidArgumentException;
  * @see			ClassLoader
  * @author		Roland Haeder <webmaster@shipsimu.org>
  * @version		1.0.1
- * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
+ * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
  * @license		GNU GPL 3.0 or any newer version
  * @link		http://www.shipsimu.org
  *
@@ -41,24 +41,23 @@ use \InvalidArgumentException;
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 class FrameworkConfiguration implements Registerable {
+	// Some constants for the configuration system
+	const EXCEPTION_CONFIG_KEY_IS_EMPTY = 0x130;
+	const EXCEPTION_CONFIG_KEY_WAS_NOT_FOUND = 0x131;
+	const EXCEPTION_CONFIG_VALUE_TYPE_UNSUPPORTED = 0x132;
 
 	/**
 	 * The framework's main configuration array which will be initialized with
 	 * hard-coded configuration data and might be overwritten/extended by
 	 * config data from the database.
 	 */
-	private static $config = array();
+	private static $configData = [];
 
 	/**
 	 * Call-back instance (unused)
 	 */
 	private $callbackInstance = NULL;
 
-	// Some constants for the configuration system
-	const EXCEPTION_CONFIG_KEY_IS_EMPTY = 0x130;
-	const EXCEPTION_CONFIG_KEY_WAS_NOT_FOUND = 0x131;
-	const EXCEPTION_CONFIG_VALUE_TYPE_UNSUPPORTED = 0x132;
-
 	/**
 	 * Default constructor, the configuration entries are static, not the
 	 * whole instance.
@@ -83,26 +82,21 @@ class FrameworkConfiguration implements Registerable {
 	 *
 	 * @param	$configKey	The configuration key we shall check
 	 * @return	$isset	Whether the given configuration key is set
-	 * @throws	NullPointerException	If $configKey is NULL
 	 * @throws	InvalidArgumentException	If $configKey is empty
 	 */
-	public function isConfigurationEntrySet ($configKey) {
+	public function isConfigurationEntrySet (string $configKey) {
 		// Is it null?
-		if (is_null($configKey)) {
-			// Throw NPE
-			throw new NullPointerException($this, BaseFrameworkSystem::EXCEPTION_IS_NULL_POINTER);
-		} elseif (!is_string($configKey)) {
-			// Is not a string
-			throw new InvalidArgumentException(sprintf('configKey[]=%s is not a string', gettype($configKey)), self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
-		} elseif ((is_string($configKey)) && (empty($configKey))) {
+		//* NOISY-DEBUG: */ printf('[%s:%d]: configKey=%s - CALLED!' . PHP_EOL, __METHOD__, __LINE__, $configKey);
+		if (empty($configKey)) {
 			// Entry is empty
-			throw new InvalidArgumentException('configKey is empty', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
+			throw new InvalidArgumentException('Parameter "configKey" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
 		}
 
 		// Is it set?
-		$isset = ((isset(self::$config[$configKey])) || (array_key_exists($configKey, self::$config)));
+		$isset = ((isset(self::$configData[$configKey])) || (array_key_exists($configKey, self::$configData)));
 
 		// Return the result
+		//* NOISY-DEBUG: */ printf('[%s:%d]: isset=%s - EXIT!' . PHP_EOL, __METHOD__, __LINE__, intval($isset));
 		return $isset;
 	}
 
@@ -111,34 +105,30 @@ class FrameworkConfiguration implements Registerable {
 	 *
 	 * @param	$configKey		The configuration element
 	 * @return	$configValue	The fetched configuration value
-	 * @throws	NullPointerException	If $configKey is NULL
 	 * @throws	InvalidArgumentException	If $configKey is empty
 	 * @throws	NoConfigEntryException		If a configuration element was not found
 	 */
-	public function getConfigEntry ($configKey) {
+	public function getConfigEntry (string $configKey) {
 		// Is it null?
-		if (is_null($configKey)) {
-			// Throw NPE
-			throw new NullPointerException($this, BaseFrameworkSystem::EXCEPTION_IS_NULL_POINTER);
-		} elseif (!is_string($configKey)) {
-			// Is not a string
-			throw new InvalidArgumentException(sprintf('configKey[]=%s is not a string', gettype($configKey)), self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
-		} elseif ((is_string($configKey)) && (empty($configKey))) {
+		//* NOISY-DEBUG: */ printf('[%s:%d]: configKey=%s - CALLED!' . PHP_EOL, __METHOD__, __LINE__, $configKey);
+		if (empty($configKey)) {
 			// Entry is empty
-			throw new InvalidArgumentException('configKey is empty', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
+			throw new InvalidArgumentException('Parameter "configKey" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
 		}
 
 		// Convert dashes to underscore
-		$configKey = StringUtils::convertDashesToUnderscores($configKey);
+		$configKey = str_replace('-', '_', $configKey);
 
 		// Is a valid configuration key provided?
+		//* NOISY-DEBUG: */ printf('[%s:%d]: configKey=%s - AFTER!' . PHP_EOL, __METHOD__, __LINE__, $configKey);
 		if (!$this->isConfigurationEntrySet($configKey)) {
 			// Entry was not found!
 			throw new NoConfigEntryException(array(__CLASS__, $configKey), self::EXCEPTION_CONFIG_KEY_WAS_NOT_FOUND);
-		} // END - if
+		}
 
 		// Return the requested value
-		return self::$config[$configKey];
+		//* NOISY-DEBUG: */ printf('[%s:%d]: Returning configData[%s]=[%s]:%s - EXIT!' . PHP_EOL, __METHOD__, __LINE__, $configKey, gettype(self::$configData[$configKey]), self::$configData[$configKey]);
+		return self::$configData[$configKey];
 	}
 
 	/**
@@ -147,35 +137,26 @@ class FrameworkConfiguration implements Registerable {
 	 * @param	$configKey	The configuration key we want to add/change
 	 * @param	$configValue	The configuration value we want to set
 	 * @return	void
-	 * @throws	NullPointerException	If $configKey is NULL
 	 * @throws	InvalidArgumentException	If $configKey is empty
 	 * @throws	InvalidArgumentException	If $configValue has an unsupported variable type
 	 */
-	public final function setConfigEntry ($configKey, $configValue) {
+	public final function setConfigEntry (string $configKey, $configValue) {
 		// Is a valid configuration key key provided?
-		if (is_null($configKey)) {
-			// Configuration key is null
-			throw new NullPointerException($this, BaseFrameworkSystem::EXCEPTION_IS_NULL_POINTER);
-		} elseif (!is_string($configKey)) {
-			// Is not a string
-			throw new InvalidArgumentException(sprintf('configKey[]=%s is not a string', gettype($configKey)), self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
-		} elseif ((is_string($configKey)) && (empty($configKey))) {
+		//* NOISY-DEBUG: */ printf('[%s:%d]: configKey=%s,configValue[]=%s - CALLED!' . PHP_EOL, __METHOD__, __LINE__, $configKey, gettype($configValue));
+		if (empty($configKey)) {
 			// Entry is empty
-			throw new InvalidArgumentException('configKey is empty', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
+			throw new InvalidArgumentException('Parameter "configKey" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
 		} elseif ((is_array($configValue)) || (is_object($configValue)) || (is_resource($configValue))) {
 			// These cannot be set as this is not intended for configuration values, please use FrameworkArrayObject instead.
 			throw new InvalidArgumentException(sprintf('configValue[]=%s for configKey=%s is not supported.', gettype($configValue), $configKey), self::EXCEPTION_CONFIG_VALUE_TYPE_UNSUPPORTED);
 		}
 
 		// Cast to string
-		$configKey = StringUtils::convertDashesToUnderscores($configKey);
+		$configKey = str_replace('-', '_', $configKey);
 
 		// Set the configuration value
-		//* NOISY-DEBUG: */ print(__METHOD__ . ':configEntry=' . $configKey . ',configValue[' . gettype($configValue) . ']=' . $configValue . PHP_EOL);
-		self::$config[$configKey] = $configValue;
-
-		// Resort the array
-		ksort(self::$config);
+		//* NOISY-DEBUG: */ printf('[%s:%d]: Setting configKey=%s,configValue[%s]=%s - EXIT!' . PHP_EOL, __METHOD__, __LINE__, $configKey, gettype($configValue), $configValue);
+		self::$configData[$configKey] = $configValue;
 	}
 
 	/**
@@ -185,7 +166,24 @@ class FrameworkConfiguration implements Registerable {
 	 */
 	public final function getConfigurationArray () {
 		// Return it
-		return self::$config;
+		//* NOISY-DEBUG: */ printf('[%s:%d]: self::configData()=%d - EXIT!' . PHP_EOL, __METHOD__, __LINE__, count(self::$configData));
+		return self::$configData;
+	}
+
+	/**
+	 * Sorts the configuration array, saves A LOT calls if done after all configuration files have been loaded. You should NOT
+	 * set any configuration entries by your own, means outside any configuration file. If you still do so, you HAVE to call
+	 * this method afterwards
+	 *
+	 * @return	void
+	 */
+	public final function sortConfigurationArray () {
+		// Resort the array
+		//* NOISY-DEBUG: */ printf('[%s:%d]: Sorting %d records - CALLED!' . PHP_EOL, __METHOD__, __LINE__, count(self::$configData));
+		ksort(self::$configData);
+
+		// Debug message
+		//* NOISY-DEBUG: */ printf('[%s:%d]: EXIT!' . PHP_EOL, __METHOD__, __LINE__);
 	}
 
 	/**
@@ -194,58 +192,68 @@ class FrameworkConfiguration implements Registerable {
 	 *
 	 * @param	$configKey	Configuration key to unset
 	 * @return	void
-	 * @throws	NullPointerException	If $configKey is NULL
 	 * @throws	InvalidArgumentException	If $configKey is empty
 	 * @throws	NoConfigEntryException	If a configuration element was not found
 	 */
-	public final function unsetConfigEntry ($configKey) {
+	public final function unsetConfigEntry (string $configKey) {
 		// Validate parameters
-		if (is_null($configKey)) {
-			// Configuration key is null
-			throw new NullPointerException($this, BaseFrameworkSystem::EXCEPTION_IS_NULL_POINTER);
-		} elseif (!is_string($configKey)) {
-			// Entry is empty
-			throw new InvalidArgumentException(sprintf('configKey[]=%s is not a string', gettype($configKey)), self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
-		} elseif ((is_string($configKey)) && (empty($configKey))) {
+		//* NOISY-DEBUG: */ printf('[%s:%d]: configKey=%s - CALLED!' . PHP_EOL, __METHOD__, __LINE__, $configKey);
+		if (empty($configKey)) {
 			// Entry is empty
-			throw new InvalidArgumentException('configKey is empty', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
+			throw new InvalidArgumentException('Parameter "configKey" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
 		}
 
 		// Convert dashes to underscore
-		$configKey = StringUtils::convertDashesToUnderscores($configKey);
+		$configKey = str_replace('-', '_', $configKey);
 
 		// Is the configuration key there?
+		//* NOISY-DEBUG: */ printf('[%s:%d]: configKey=%s - AFTER!' . PHP_EOL, __METHOD__, __LINE__, $configKey);
 		if (!$this->isConfigurationEntrySet($configKey)) {
 			// Entry was not found!
 			throw new NoConfigEntryException(array(__CLASS__, $configKey), self::EXCEPTION_CONFIG_KEY_WAS_NOT_FOUND);
-		} // END - if
+		}
 
 		// Unset it
-		unset(self::$config[$configKey]);
-	}
+		//* NOISY-DEBUG: */ printf('[%s:%d]: Unsetting configKey=%s ...' . PHP_EOL, __METHOD__, __LINE__, $configKey);
+		unset(self::$configData[$configKey]);
 
-	/**
-	 * Getter for field name
-	 *
-	 * @param	$fieldName		Field name which we shall get
-	 * @return	$fieldValue		Field value from the user
-	 * @throws	NullPointerException	If the result instance is null
-	 */
-	public final function getField ($fieldName) {
-		// The super interface "FrameworkInterface" requires this
-		throw new UnsupportedOperationException(array($this, __FUNCTION__), BaseFrameworkSystem::EXCEPTION_UNSPPORTED_OPERATION);
+		// Debug message
+		//* NOISY-DEBUG: */ printf('[%s:%d]: EXIT!' . PHP_EOL, __METHOD__, __LINE__);
 	}
 
 	/**
-	 * Checks if given field is set
+	 * Checks if a configuration entry is_*_enabled set to 'Y'
 	 *
-	 * @param	$fieldName	Field name to check
-	 * @return	$isSet		Whether the given field name is set
-	 * @throws	NullPointerException	If the result instance is null
+	 * @param	$keyPart	Configuration to expand with is_$keyPart_enabled
+	 * @return	$enabled	Whether it has been set to Y or N
+	 * @throws	InvalidArgumentException	If a parameter is invalid
+	 * @throws	UnexpectedValueException	If a returned value is of an unexpected type or value
 	 */
-	public function isFieldSet ($fieldName) {
-		// The super interface "FrameworkInterface" requires this
-		throw new UnsupportedOperationException(array($this, __FUNCTION__), BaseFrameworkSystem::EXCEPTION_UNSPPORTED_OPERATION);
+	public function isEnabled (string $keyPart) {
+		// Validate parameters
+		//* NOISY-DEBUG: */ printf('[%s:%d]: keyPart=%s - CALLED!' . PHP_EOL, __METHOD__, __LINE__, $keyPart);
+		if (empty($keyPart)) {
+			// Entry is empty
+			throw new InvalidArgumentException('Parameter "keyPart" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
+		}
+
+		// Construct final config key
+		$configKey = sprintf('is_%s_enabled', $keyPart);
+
+		// Get value from it
+		//* NOISY-DEBUG: */ printf('[%s:%d]: configKey=%s' . PHP_EOL, __METHOD__, __LINE__, $configKey);
+		$isEnabled = $this->getConfigEntry($configKey);
+
+		// Is it Y/N?
+		//* NOISY-DEBUG: */ printf('[%s:%d]: isEnabled[]=%s' . PHP_EOL, __METHOD__, __LINE__, gettype($isEnabled));
+		if (!is_bool($isEnabled)) {
+			// Throw exception
+			throw new UnexpectedValueException(sprintf('isEnabled[]=%s is unexpected', gettype($isEnabled)), FrameworkInterface::EXCEPTION_UNEXPECTED_VALUE);
+		}
+
+		// Return it
+		//* NOISY-DEBUG: */ printf('[%s:%d]: isEnabled=%d - EXIT!' . PHP_EOL, __METHOD__, __LINE__, intval($isEnabled));
+		return $isEnabled;
 	}
 
 	/**
@@ -286,4 +294,28 @@ class FrameworkConfiguration implements Registerable {
 		$this->callbackInstance = $callbackInstance;
 	}
 
+	/**
+	 * Getter for field name
+	 *
+	 * @param	$fieldName		Field name which we shall get
+	 * @return	$fieldValue		Field value from the user
+	 * @throws	NullPointerException	If the result instance is null
+	 */
+	public final function getField (string $fieldName) {
+		// The super interface "FrameworkInterface" requires this
+		throw new UnsupportedOperationException([$this, __FUNCTION__], FrameworkInterface::EXCEPTION_UNSPPORTED_OPERATION);
+	}
+
+	/**
+	 * Checks if given field is set
+	 *
+	 * @param	$fieldName	Field name to check
+	 * @return	$isSet		Whether the given field name is set
+	 * @throws	NullPointerException	If the result instance is null
+	 */
+	public function isFieldSet (string $fieldName) {
+		// The super interface "FrameworkInterface" requires this
+		throw new UnsupportedOperationException([$this, __FUNCTION__], FrameworkInterface::EXCEPTION_UNSPPORTED_OPERATION);
+	}
+
 }