X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fconfig%2Fclass_FrameworkConfiguration.php;h=a49d4aa966b06c1726daa6b4adb2ab3f10893af3;hp=a1dd68061a3c7ef829092fd710899a3418a8f664;hb=c3021952494266e05bfa9046baf9bcd11bfe7d13;hpb=2101ed20f68ad482c5076d06b3ab1c836604b837 diff --git a/inc/config/class_FrameworkConfiguration.php b/inc/config/class_FrameworkConfiguration.php index a1dd6806..a49d4aa9 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 @@ -54,16 +54,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 +72,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 +97,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 +112,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; @@ -108,7 +134,7 @@ class FrameworkConfiguration implements Registerable { * @param $configEntry The configuration entry we shall check * @return $isset Whether the given configuration entry is set */ - protected function isConfigurationEntrySet ($configEntry) { + public function isConfigurationEntrySet ($configEntry) { // Is it set? $isset = isset($this->config[$configEntry]); @@ -125,8 +151,8 @@ class FrameworkConfiguration implements Registerable { * @throws NoConfigEntryException If a configuration element was not found */ public function getConfigEntry ($configEntry) { - // Cast to string - $configEntry = (string) $configEntry; + // Convert dashes to underscore + $configEntry = $this->convertDashesToUnderscores($configEntry); // Is a valid configuration entry provided? if (empty($configEntry)) { @@ -151,7 +177,7 @@ class FrameworkConfiguration implements Registerable { */ public final function setConfigEntry ($configEntry, $configValue) { // Cast to string - $configEntry = (string) $configEntry; + $configEntry = $this->convertDashesToUnderscores($configEntry); $configValue = (string) $configValue; // Is a valid configuration entry provided? @@ -172,19 +198,22 @@ class FrameworkConfiguration implements Registerable { * Unset a configuration entry, the entry must be there or else an * exception is thrown. * - * @param $configKey Configuration entry to unset + * @param $configEntry Configuration entry to unset * @return void * @throws NoConfigEntryException If a configuration element was not found */ - public final function unsetConfigEntry ($configKey) { + public final function unsetConfigEntry ($configEntry) { + // Convert dashes to underscore + $configEntry = $this->convertDashesToUnderscores($configEntry); + // Is the configuration entry there? - if (!$this->isConfigurationEntrySet($configKey)) { + if (!$this->isConfigurationEntrySet($configEntry)) { // Entry was not found! - throw new NoConfigEntryException(array(__CLASS__, $configKey), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND); + throw new NoConfigEntryException(array(__CLASS__, $configEntry), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND); } // END - if // Unset it - unset($this->config[$configKey]); + unset($this->config[$configEntry]); } /**