X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=framework%2Fconfig%2Fclass_FrameworkConfiguration.php;h=09df67fbbbceb5c323b99d0c9740ffc8dc56c5c9;hb=ded0af2917fc31d6516968cbda5e733b67cbf1de;hp=17c456e7eb2a30a11da4be1e24b89f5c81543a5f;hpb=b954ccaa3dbfc59ddc76e463d2980a5dc204cc9f;p=core.git diff --git a/framework/config/class_FrameworkConfiguration.php b/framework/config/class_FrameworkConfiguration.php index 17c456e7..09df67fb 100644 --- a/framework/config/class_FrameworkConfiguration.php +++ b/framework/config/class_FrameworkConfiguration.php @@ -1,14 +1,18 @@ - * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team + * @version 1.0.1 + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2021 Core Developer Team * @license GNU GPL 3.0 or any newer version * @link http://www.shipsimu.org * @@ -37,34 +41,30 @@ use CoreFramework\Registry\Registerable; * 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 $config = array(); - - /** - * The configuration instance itself - */ - private static $configInstance = NULL; + 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; - /** - * Protected constructor + * Default constructor, the configuration entries are static, not the + * whole instance. * * @return void */ - protected function __construct () { + public function __construct () { // Empty for now } @@ -77,83 +77,22 @@ class FrameworkConfiguration implements Registerable { return get_class($this); } - /** - * Getter for a singleton instance of this class - * - * @return $configInstance A singleton instance of this class - */ - 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) - * @return void - */ - public final function setDefaultTimezone ($zone) { - // Is PHP version 5.1.0 or higher? Older versions are being ignored - if (version_compare(phpversion(), '5.1.0', '>=')) { - /* - * Set desired time zone to prevent date() and related functions to - * issue a E_WARNING. - */ - date_default_timezone_set($zone); - } // END - if - } - - /** - * Setter for runtime magic quotes - * - * @param $enableQuotes Whether enable magic runtime quotes (should be disabled for security reasons) - * @return void - * @todo This method encapsulates a deprecated PHP function and should be deprecated, too. - */ - public final function setMagicQuotesRuntime ($enableQuotes) { - // Is the PHP version < 5.4? - if (version_compare(phpversion(), '5.4', '>=')) { - // Then silently skip this part as set_magic_quotes_runtime() is deprecated - return; - } // END - if - - // Cast it to boolean - $enableQuotes = (boolean) $enableQuotes; - - // Set it - set_magic_quotes_runtime($enableQuotes); - } - /** * Checks whether the given configuration key is set * * @param $configKey The configuration key we shall check - * @return $isset Whether the given configuration key is set + * @return $isset Whether the given configuration key is set + * @throws InvalidArgumentException If $configKey is empty */ - public function isConfigurationEntrySet ($configKey) { + public function isConfigurationEntrySet (string $configKey) { + // Is it null? + if (empty($configKey)) { + // Entry is empty + throw new InvalidArgumentException('Parameter "configKey" is empty', self::EXCEPTION_CONFIG_KEY_IS_EMPTY); + } + // Is it set? - $isset = isset($this->config[$configKey]); + $isset = ((isset(self::$configData[$configKey])) || (array_key_exists($configKey, self::$configData))); // Return the result return $isset; @@ -164,24 +103,30 @@ class FrameworkConfiguration implements Registerable { * * @param $configKey The configuration element * @return $configValue The fetched configuration value - * @throws ConfigEntryIsEmptyException If $configKey is empty - * @throws NoConfigEntryException If a configuration element was not found + * @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? + //* NOISY-DEBUG: */ printf('[%s:%d]: configKey=%s - CALLED!' . PHP_EOL, __METHOD__, __LINE__, $configKey); + if (empty($configKey)) { + // Entry is empty + throw new InvalidArgumentException('Parameter "configKey" is empty', self::EXCEPTION_CONFIG_KEY_IS_EMPTY); + } + // Convert dashes to underscore - $configKey = self::convertDashesToUnderscores($configKey); + $configKey = StringUtils::convertDashesToUnderscores($configKey); // Is a valid configuration key provided? - if (empty($configKey)) { - // Entry is empty - throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_KEY_IS_EMPTY); - } elseif (!$this->isConfigurationEntrySet($configKey)) { + //* 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 $this->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]; } /** @@ -190,31 +135,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 ConfigEntryIsEmptyException If $configKey is empty - * @throws ConfigValueTypeUnsupportedException If $configValue has an unsupported variable type + * @throws InvalidArgumentException If $configKey is empty + * @throws InvalidArgumentException If $configValue has an unsupported variable type */ - public final function setConfigEntry ($configKey, $configValue) { - // Cast to string - $configKey = self::convertDashesToUnderscores($configKey); - + 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, self::EXCEPTION_IS_NULL_POINTER); - } elseif ((empty($configKey)) || (!is_string($configKey))) { + //* NOISY-DEBUG: */ printf('[%s:%d]: configKey=%s,configValue[]=%s' . PHP_EOL, __METHOD__, __LINE__, $configKey, gettype($configValue)); + if (empty($configKey)) { // Entry is empty - throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_KEY_IS_EMPTY); - } elseif ((is_null($configValue)) || (is_array($configValue)) || (is_object($configValue)) || (is_resource($configValue))) { + 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 ConfigValueTypeUnsupportedException(array($this, $configKey, $configValue), self::EXCEPTION_CONFIG_VALUE_TYPE_UNSUPPORTED); + throw new InvalidArgumentException(sprintf('configValue[]=%s for configKey=%s is not supported.', gettype($configValue), $configKey), self::EXCEPTION_CONFIG_VALUE_TYPE_UNSUPPORTED); } - // Set the configuration value - //* NOISY-DEBUG: */ print(__METHOD__ . ':configEntry=' . $configKey . ',configValue[' . gettype($configValue) . ']=' . $configValue . PHP_EOL); - $this->config[$configKey] = $configValue; + // Cast to string + $configKey = StringUtils::convertDashesToUnderscores($configKey); - // Resort the array - ksort($this->config); + // Set the configuration value + //* NOISY-DEBUG: */ printf('[%s:%d]: configKey=%s,configValue[%s]=%s' . PHP_EOL, __METHOD__, __LINE__, $configKey, gettype($configValue), $configValue); + self::$configData[$configKey] = $configValue; } /** @@ -224,7 +164,24 @@ class FrameworkConfiguration implements Registerable { */ public final function getConfigurationArray () { // Return it - return $this->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__); } /** @@ -233,170 +190,71 @@ class FrameworkConfiguration implements Registerable { * * @param $configKey Configuration key to unset * @return void + * @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 + //* NOISY-DEBUG: */ printf('[%s:%d]: configKey=%s - CALLED!' . PHP_EOL, __METHOD__, __LINE__, $configKey); + if (empty($configKey)) { + // Entry is empty + throw new InvalidArgumentException('Parameter "configKey" is empty', self::EXCEPTION_CONFIG_KEY_IS_EMPTY); + } + // Convert dashes to underscore - $configKey = self::convertDashesToUnderscores($configKey); + $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); - } // END - if + } // Unset it - unset($this->config[$configKey]); - } + //* NOISY-DEBUG: */ printf('[%s:%d]: Unsetting configKey=%s ...' . PHP_EOL, __METHOD__, __LINE__, $configKey); + unset(self::$configData[$configKey]); - /** - * Detects the server address (SERVER_ADDR) and set it in configuration - * - * @return $serverAddress The detected server address - * @throws UnknownHostnameException If SERVER_NAME cannot be resolved to an IP address - * @todo Have to check some more entries from $_SERVER here - */ - public function detectServerAddress () { - // Is the entry set? - if (!$this->isConfigurationEntrySet('server_addr')) { - // Is it set in $_SERVER? - if (isset($_SERVER['SERVER_ADDR'])) { - // Set it from $_SERVER - $this->setServerAddress($_SERVER['SERVER_ADDR']); - } elseif (isset($_SERVER['SERVER_NAME'])) { - // Resolve IP address - $serverIp = ConsoleTools::resolveIpAddress($_SERVER['SERVER_NAME']); - - // Is it valid? - if ($serverIp === false) { - /* - * Why is gethostbyname() returning the host name and not - * false as many other PHP functions are doing? ;-( - */ - throw new UnknownHostnameException(sprintf('Cannot resolve "%s" to an IP address. Please fix your setup.', $_SERVER['SERVER_NAME'])); - } // END - if - - // Al fine, set it - $this->setServerAddress($serverIp); - } else { - // Run auto-detecting through console tools lib - ConsoleTools::acquireSelfIPAddress(); - } - } // END - if - - // Now get it from configuration - $serverAddress = $this->getServerAddress(); - - // Return it - return $serverAddress; + // Debug message + //* NOISY-DEBUG: */ printf('[%s:%d]: EXIT!' . PHP_EOL, __METHOD__, __LINE__); } /** - * Setter for SERVER_ADDR - * - * @param $serverAddress New SERVER_ADDR value to set - * @return void - */ - public function setServerAddress ($serverAddress) { - $this->setConfigEntry('server_addr', (string) $serverAddress); - } - - /** - * Getter for SERVER_ADDR - * - * @return $serverAddress New SERVER_ADDR value to set - */ - public function getServerAddress () { - return $this->getConfigEntry('server_addr'); - } - - /** - * Detects the HTTPS flag - * - * @return $isSecured The detected HTTPS flag or null if failed - */ - public function detectHttpSecured () { - // Default is null - $isSecured = NULL; - - // Is HTTPS set? - if ($this->isHttpSecured()) { - // Then use it - $isSecured = $_SERVER['HTTPS']; - } // END - if - - // Return it - return $isSecured; - } - - /** - * Checks whether HTTPS is set in $_SERVER - * - * @return $isset Whether HTTPS is set - */ - public function isHttpSecured () { - return (isset($_SERVER['HTTPS'])); - } - - /** - * Dectect and return the base URL for all URLs and forms + * Generates a code for hashes from this class * - * @return $baseUrl Detected base URL + * @return $hashCode The hash code respresenting this class */ - public function detectBaseUrl () { - // Initialize the URL - $baseUrl = 'http'; - - // Do we have HTTPS? - if ($this->isHttpSecured()) { - // Add the >s< for HTTPS - $baseUrl .= 's'; - } // END - if - - // Construct the full URL and secure it against CSRF attacks - $baseUrl = $baseUrl . '://' . $this->detectDomain() . $this->detectScriptPath(); - - // Return the URL - return $baseUrl; + public function hashCode () { + return crc32($this->__toString()); } /** - * Detect safely and return the full domain where this script is installed + * Checks whether an object equals this object. You should overwrite this + * method to implement own equality checks * - * @return $fullDomain The detected full domain + * @param $objectInstance An instance of a FrameworkInterface object + * @return $equals Whether both objects equals */ - public function detectDomain () { - // Full domain is localnet.invalid by default - $fullDomain = 'localnet.invalid'; - - // Is the server name there? - if (isset($_SERVER['SERVER_NAME'])) { - // Detect the full domain - $fullDomain = htmlentities(strip_tags($_SERVER['SERVER_NAME']), ENT_QUOTES); - } // END - if + public function equals (FrameworkInterface $objectInstance) { + // Now test it + $equals = (( + $this->__toString() === $objectInstance->__toString() + ) && ( + $this->hashCode() === $objectInstance->hashCode() + )); - // Return it - return $fullDomain; + // Return the result + return $equals; } /** - * Detect safely the script path without trailing slash which is the glue - * between "http://your-domain.invalid/" and "script-name.php" + * Setter for call-back instance * - * @return $scriptPath The script path extracted from $_SERVER['SCRIPT_NAME'] + * @param $callbackInstance An instance of a FrameworkInterface class + * @return void */ - public function detectScriptPath () { - // Default is empty - $scriptPath = ''; - - // Is the scriptname set? - if (isset($_SERVER['SCRIPT_NAME'])) { - // Get dirname from it and replace back-slashes with slashes for lame OSes... - $scriptPath = str_replace("\\", '/', dirname($_SERVER['SCRIPT_NAME'])); - } // END - if - - // Return it - return $scriptPath; + public function setCallbackInstance (FrameworkInterface $callbackInstance) { + $this->callbackInstance = $callbackInstance; } /** @@ -406,9 +264,9 @@ class FrameworkConfiguration implements Registerable { * @return $fieldValue Field value from the user * @throws NullPointerException If the result instance is null */ - public final function getField ($fieldName) { + public final function getField (string $fieldName) { // The super interface "FrameworkInterface" requires this - throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION); + throw new UnsupportedOperationException(array($this, __FUNCTION__), BaseFrameworkSystem::EXCEPTION_UNSPPORTED_OPERATION); } /** @@ -418,47 +276,9 @@ class FrameworkConfiguration implements Registerable { * @return $isSet Whether the given field name is set * @throws NullPointerException If the result instance is null */ - public function isFieldSet ($fieldName) { + public function isFieldSet (string $fieldName) { // The super interface "FrameworkInterface" requires this - throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION); - } - - /** - * Generates a code for hashes from this class - * - * @return $hashCode The hash code respresenting this class - */ - 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; - } - - /** - * Setter for call-back instance - * - * @param $callbackInstance An instance of a FrameworkInterface class - * @return void - */ - public function setCallbackInstance (FrameworkInterface $callbackInstance) { - $this->callbackInstance = $callbackInstance; + throw new UnsupportedOperationException(array($this, __FUNCTION__), BaseFrameworkSystem::EXCEPTION_UNSPPORTED_OPERATION); } }