Continued:

[core.git] / framework / config / class_FrameworkConfiguration.php

diff --git a/framework/config/class_FrameworkConfiguration.php b/framework/config/class_FrameworkConfiguration.php
index e43a3b86eb773f80f96050d71df88d0d52fe6a3b..d5d400d0699bb55a665199e6752129fd6867f172 100644 (file)
--- a/framework/config/class_FrameworkConfiguration.php
+++ b/framework/config/class_FrameworkConfiguration.php
@@ -15,7 +15,7 @@ use Org\Mxchange\CoreFramework\Utils\Strings\StringUtils;
 use \InvalidArgumentException;
 
 /**
- * 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 - 2021 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2022 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.shipsimu.org
  *
@@ -88,7 +88,7 @@ class FrameworkConfiguration implements Registerable {
                // Is it null?
                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', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
                }
 
                // Is it set?
@@ -108,21 +108,24 @@ class FrameworkConfiguration implements Registerable {
         */
        public function getConfigEntry (string $configKey) {
                // Is it null?
+               //* 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', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
                }
 
                // Convert dashes to underscore
                $configKey = StringUtils::convertDashesToUnderscores($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);
                }
 
                // Return the requested value
+               //* 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];
        }
 
@@ -137,9 +140,10 @@ class FrameworkConfiguration implements Registerable {
         */
        public final function setConfigEntry (string $configKey, $configValue) {
                // Is a valid configuration key key provided?
+               //* NOISY-DEBUG: */ printf('[%s:%d]: configKey=%s,configValue[]=%s' . 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', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
                } 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);
@@ -149,11 +153,8 @@ class FrameworkConfiguration implements Registerable {
                $configKey = StringUtils::convertDashesToUnderscores($configKey);
 
                // Set the configuration value
-               //* NOISY-DEBUG: */ print(__METHOD__ . ':configEntry=' . $configKey . ',configValue[' . gettype($configValue) . ']=' . $configValue . PHP_EOL);
+               //* NOISY-DEBUG: */ printf('[%s:%d]: configKey=%s,configValue[%s]=%s' . PHP_EOL, __METHOD__, __LINE__, $configKey, gettype($configValue), $configValue);
                self::$configData[$configKey] = $configValue;
-
-               // Resort the array
-               ksort(self::$configData);
        }
 
        /**
@@ -163,9 +164,26 @@ class FrameworkConfiguration implements Registerable {
         */
        public final function getConfigurationArray () {
                // Return it
+               //* 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__);
+       }
+
        /**
         * Unset a configuration key, the entry must be there or else an
         * exception is thrown.
@@ -177,22 +195,28 @@ class FrameworkConfiguration implements Registerable {
         */
        public final function unsetConfigEntry (string $configKey) {
                // Validate parameters
+               //* 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', self::EXCEPTION_CONFIG_KEY_IS_EMPTY);
                }
 
                // Convert dashes to underscore
                $configKey = StringUtils::convertDashesToUnderscores($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);
                }
 
                // Unset it
+               //* NOISY-DEBUG: */ printf('[%s:%d]: Unsetting configKey=%s ...' . PHP_EOL, __METHOD__, __LINE__, $configKey);
                unset(self::$configData[$configKey]);
+
+               // Debug message
+               //* NOISY-DEBUG: */ printf('[%s:%d]: EXIT!' . PHP_EOL, __METHOD__, __LINE__);
        }
 
        /**