X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fconfig%2Fclass_FrameworkConfiguration.php;h=a49d4aa966b06c1726daa6b4adb2ab3f10893af3;hp=938b67ba99c954a1265b1e44dedf1be577554eee;hb=c3021952494266e05bfa9046baf9bcd11bfe7d13;hpb=3e1fbf30a631cf1cd64562b69228452c49e0033f diff --git a/inc/config/class_FrameworkConfiguration.php b/inc/config/class_FrameworkConfiguration.php index 938b67ba..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 - 2011 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,44 +54,73 @@ 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 getInstance () { + 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) + * @param $zone The time-zone string (e.g. Europe/Berlin) * @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 } /** * 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; @@ -100,12 +129,12 @@ class FrameworkConfiguration implements Registerable { } /** - * Checks wether the given configuration entry is set + * Checks whether the given configuration entry is set * * @param $configEntry The configuration entry we shall check - * @return $isset Wether the given configuration entry is set + * @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]); @@ -116,55 +145,77 @@ class FrameworkConfiguration implements Registerable { /** * Read a configuration element. * - * @param $cfgEntry The configuration element - * @return $cfgValue The fetched configuration value - * @throws ConfigEntryIsEmptyException If $cfgEntry is empty - * @throws NoConfigEntryException If a configuration element - * was not found + * @param $configEntry The configuration element + * @return $configValue The fetched configuration value + * @throws ConfigEntryIsEmptyException If $configEntry is empty + * @throws NoConfigEntryException If a configuration element was not found */ - public function getConfigEntry ($cfgEntry) { - // Cast to string - $cfgEntry = (string) $cfgEntry; + public function getConfigEntry ($configEntry) { + // Convert dashes to underscore + $configEntry = $this->convertDashesToUnderscores($configEntry); // Is a valid configuration entry provided? - if (empty($cfgEntry)) { + if (empty($configEntry)) { // Entry is empty throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY); - } elseif (!$this->isConfigurationEntrySet($cfgEntry)) { + } elseif (!$this->isConfigurationEntrySet($configEntry)) { // Entry was not found! - throw new NoConfigEntryException(array(__CLASS__, $cfgEntry), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND); + throw new NoConfigEntryException(array(__CLASS__, $configEntry), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND); } // Return the requested value - return $this->config[$cfgEntry]; + return $this->config[$configEntry]; } /** - * Set a configuration entry. + * Set a configuration entry * - * @param $cfgEntry The configuration entry we want to add/change - * @param $cfgValue The configuration value we want to set + * @param $configEntry The configuration entry we want to add/change + * @param $configValue The configuration value we want to set * @return void - * @throws ConfigEntryIsEmptyException If $cfgEntry is empty + * @throws ConfigEntryIsEmptyException If $configEntry is empty */ - public final function setConfigEntry ($cfgEntry, $cfgValue) { + public final function setConfigEntry ($configEntry, $configValue) { // Cast to string - $cfgEntry = (string) $cfgEntry; - $cfgValue = (string) $cfgValue; + $configEntry = $this->convertDashesToUnderscores($configEntry); + $configValue = (string) $configValue; // Is a valid configuration entry provided? - if (empty($cfgEntry)) { + if (empty($configEntry)) { // Entry is empty throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY); } // END - if // Set the configuration value - $this->config[$cfgEntry] = $cfgValue; + //* NOISY-DEBUG: */ print(__METHOD__ . ':configEntry=' . $configEntry . ',configValue=' . $configValue . PHP_EOL); + $this->config[$configEntry] = $configValue; // Resort the array ksort($this->config); } + /** + * Unset a configuration entry, the entry must be there or else an + * exception is thrown. + * + * @param $configEntry Configuration entry to unset + * @return void + * @throws NoConfigEntryException If a configuration element was not found + */ + public final function unsetConfigEntry ($configEntry) { + // Convert dashes to underscore + $configEntry = $this->convertDashesToUnderscores($configEntry); + + // Is the configuration entry there? + if (!$this->isConfigurationEntrySet($configEntry)) { + // Entry was not found! + throw new NoConfigEntryException(array(__CLASS__, $configEntry), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND); + } // END - if + + // Unset it + unset($this->config[$configEntry]); + } + /** * Detects the server address (SERVER_ADDR) and set it in configuration * @@ -230,9 +281,9 @@ class FrameworkConfiguration implements Registerable { } /** - * Checks wether HTTPS is set in $_SERVER + * Checks whether HTTPS is set in $_SERVER * - * @return $isset Wether HTTPS is set + * @return $isset Whether HTTPS is set */ public function isHttpSecured () { return (isset($_SERVER['HTTPS'])); @@ -320,11 +371,11 @@ class FrameworkConfiguration implements Registerable { } /** - * Checks wether an object equals this object. You should overwrite this + * 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 Wether both objects equals + * @return $equals Whether both objects equals */ public function equals (FrameworkInterface $objectInstance) { // Now test it