X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=framework%2Fconfig%2Fclass_FrameworkConfiguration.php;h=d5d400d0699bb55a665199e6752129fd6867f172;hb=fcab9400e746a6d4b0b36fce2452c99973256149;hp=2afe681ba475bd6857b3730629a90f3b820d90b1;hpb=53bf33122fffeedc46ea50c84cbbdd9e2aabd45d;p=core.git diff --git a/framework/config/class_FrameworkConfiguration.php b/framework/config/class_FrameworkConfiguration.php index 2afe681b..d5d400d0 100644 --- a/framework/config/class_FrameworkConfiguration.php +++ b/framework/config/class_FrameworkConfiguration.php @@ -9,13 +9,13 @@ use Org\Mxchange\CoreFramework\Generic\FrameworkInterface; use Org\Mxchange\CoreFramework\Generic\UnsupportedOperationException; use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem; use Org\Mxchange\CoreFramework\Registry\Registerable; -use Org\Mxchange\CoreFramework\Utils\String\StringUtils; +use Org\Mxchange\CoreFramework\Utils\Strings\StringUtils; // Import SPL stuff 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 * @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 * @@ -41,24 +41,23 @@ use \InvalidArgumentException; * along with this program. If not, see . */ 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 = []; + 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. @@ -89,11 +88,11 @@ 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? - $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 return $isset; @@ -109,22 +108,25 @@ 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 - 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]; } /** @@ -138,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); @@ -150,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); - self::$config[$configKey] = $configValue; - - // Resort the array - ksort(self::$config); + //* NOISY-DEBUG: */ printf('[%s:%d]: configKey=%s,configValue[%s]=%s' . PHP_EOL, __METHOD__, __LINE__, $configKey, gettype($configValue), $configValue); + self::$configData[$configKey] = $configValue; } /** @@ -164,7 +164,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__); } /** @@ -178,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 - unset(self::$config[$configKey]); + //* 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__); } /**