X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fconfig%2Fclass_FrameworkConfiguration.php;h=914d13a183b397e0d77b573176932c384be6dd50;hp=38ccf6e5c2c79b345b99610326f41d9e87ba9056;hb=58bc43a5a34265bc579ea663a804eb8a1843ac37;hpb=5dcdec05cf48f5f940dabab64e3a59e0570ebae3 diff --git a/inc/config/class_FrameworkConfiguration.php b/inc/config/class_FrameworkConfiguration.php index 38ccf6e5..914d13a1 100644 --- a/inc/config/class_FrameworkConfiguration.php +++ b/inc/config/class_FrameworkConfiguration.php @@ -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!) * @@ -119,55 +134,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 *