X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fconfig%2Fclass_FrameworkConfiguration.php;h=d6ff28a24da1226428e14824e42cf8e6ccfb462d;hp=71e0da4c11716e09ba738ba4ee3f799595894c3b;hb=1c4fc1ae50d2e99f9e52a2fe86c15caeab55de70;hpb=ddc8b6b30361d35a304a2b0e596dafc154799dbf diff --git a/inc/config/class_FrameworkConfiguration.php b/inc/config/class_FrameworkConfiguration.php index 71e0da4c..d6ff28a2 100644 --- a/inc/config/class_FrameworkConfiguration.php +++ b/inc/config/class_FrameworkConfiguration.php @@ -6,11 +6,11 @@ * class loader. See inc/loader/class_ClassLoader.php for instance * * @see ClassLoader - * @author Roland Haeder + * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team * @license GNU GPL 3.0 or any newer version - * @link http://www.ship-simu.org + * @link http://www.shipsimu.org * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -39,8 +39,9 @@ class FrameworkConfiguration implements Registerable { private static $configInstance = NULL; // Some constants for the configuration system - const EXCEPTION_CONFIG_ENTRY_IS_EMPTY = 0x130; - const EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND = 0x131; + const EXCEPTION_CONFIG_KEY_IS_EMPTY = 0x130; + const EXCEPTION_CONFIG_KEY_WAS_NOT_FOUND = 0x131; + const EXCEPTION_CONFIG_VALUE_TYPE_UNSUPPORTED = 0x132; /** * Protected constructor @@ -54,16 +55,16 @@ class FrameworkConfiguration implements Registerable { /** * Compatiblity method to return this class' name * - * @return __CLASS__ This class' name + * @return __CLASS__ This class' name */ public function __toString () { return get_class($this); } /** - * Getter for an instance of this class + * Getter for a singleton instance of this class * - * @return $configInstance An instance of this class + * @return $configInstance A singleton instance of this class */ public static final function getSelfInstance () { // is the instance there? @@ -72,9 +73,24 @@ class FrameworkConfiguration implements Registerable { 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!) * @@ -82,8 +98,12 @@ class FrameworkConfiguration implements Registerable { * @return void */ public final function setDefaultTimezone ($zone) { - // At least 5.1.0 is required for this! - if (version_compare(phpversion(), '5.1.0')) { + // 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 } @@ -93,8 +113,15 @@ class FrameworkConfiguration implements Registerable { * * @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; @@ -103,14 +130,14 @@ class FrameworkConfiguration implements Registerable { } /** - * Checks whether the given configuration entry is set + * Checks whether the given configuration key is set * - * @param $configEntry The configuration entry we shall check - * @return $isset Whether the given configuration entry is set + * @param $configKey The configuration key we shall check + * @return $isset Whether the given configuration key is set */ - protected function isConfigurationEntrySet ($configEntry) { + public function isConfigurationEntrySet ($configKey) { // Is it set? - $isset = isset($this->config[$configEntry]); + $isset = isset($this->config[$configKey]); // Return the result return $isset; @@ -119,67 +146,74 @@ class FrameworkConfiguration implements Registerable { /** * Read a configuration element. * - * @param $configEntry The configuration element + * @param $configKey The configuration element * @return $configValue The fetched configuration value - * @throws ConfigEntryIsEmptyException If $configEntry is empty - * @throws NoConfigEntryException If a configuration element was not found + * @throws ConfigEntryIsEmptyException If $configKey is empty + * @throws NoConfigEntryException If a configuration element was not found */ - public function getConfigEntry ($configEntry) { - // Cast to string - $configEntry = (string) $configEntry; + public function getConfigEntry ($configKey) { + // Convert dashes to underscore + $configKey = $this->convertDashesToUnderscores($configKey); - // Is a valid configuration entry provided? - if (empty($configEntry)) { + // Is a valid configuration key provided? + if (empty($configKey)) { // Entry is empty - throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY); - } elseif (!$this->isConfigurationEntrySet($configEntry)) { + throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_KEY_IS_EMPTY); + } elseif (!$this->isConfigurationEntrySet($configKey)) { // Entry was not found! - throw new NoConfigEntryException(array(__CLASS__, $configEntry), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND); + throw new NoConfigEntryException(array(__CLASS__, $configKey), self::EXCEPTION_CONFIG_KEY_WAS_NOT_FOUND); } // Return the requested value - return $this->config[$configEntry]; + return $this->config[$configKey]; } /** - * Set a configuration entry + * Set a configuration key * - * @param $configEntry The configuration entry we want to add/change + * @param $configKey The configuration key we want to add/change * @param $configValue The configuration value we want to set * @return void - * @throws ConfigEntryIsEmptyException If $configEntry is empty + * @throws ConfigEntryIsEmptyException If $configKey is empty + * @throws ConfigValueTypeUnsupportedException If $configValue has an unsupported variable type */ - public final function setConfigEntry ($configEntry, $configValue) { + public final function setConfigEntry ($configKey, $configValue) { // Cast to string - $configEntry = (string) $configEntry; - $configValue = (string) $configValue; + $configKey = $this->convertDashesToUnderscores($configKey); - // Is a valid configuration entry provided? - if (empty($configEntry)) { + // Is a valid configuration key key provided? + if ((empty($configKey)) || (!is_string($configKey))) { // Entry is empty - throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY); - } // END - if + throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_KEY_IS_EMPTY); + } elseif ((is_null($configValue)) || (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); + } // Set the configuration value - $this->config[$configEntry] = $configValue; + //* NOISY-DEBUG: */ print(__METHOD__ . ':configEntry=' . $configKey . ',configValue[' . gettype($configValue) . ']=' . $configValue . PHP_EOL); + $this->config[$configKey] = $configValue; // Resort the array ksort($this->config); } /** - * Unset a configuration entry, the entry must be there or else an + * Unset a configuration key, the entry must be there or else an * exception is thrown. * - * @param $configKey Configuration entry to unset + * @param $configKey Configuration key to unset * @return void * @throws NoConfigEntryException If a configuration element was not found */ public final function unsetConfigEntry ($configKey) { - // Is the configuration entry there? + // Convert dashes to underscore + $configKey = $this->convertDashesToUnderscores($configKey); + + // Is the configuration key there? if (!$this->isConfigurationEntrySet($configKey)) { // Entry was not found! - throw new NoConfigEntryException(array(__CLASS__, $configKey), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND); + throw new NoConfigEntryException(array(__CLASS__, $configKey), self::EXCEPTION_CONFIG_KEY_WAS_NOT_FOUND); } // END - if // Unset it @@ -331,6 +365,17 @@ class FrameworkConfiguration implements Registerable { // Our super interface "FrameworkInterface" requires this } + /** + * 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 ($fieldName) { + // Our super interface "FrameworkInterface" requires this + } + /** * Generates a code for hashes from this class *