Introduced isFieldSet().

[core.git] / inc / config / class_FrameworkConfiguration.php

diff --git a/inc/config/class_FrameworkConfiguration.php b/inc/config/class_FrameworkConfiguration.php
index 6743ab4b59e023da085290c3226b3d40f91856c7..8d786742b6492a6589cdc576617a4fd782fd5512 100644 (file)
--- 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 <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @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?
@@ -161,6 +187,7 @@ class FrameworkConfiguration implements Registerable {
                } // END - if
 
                // Set the configuration value
+               //* NOISY-DEBUG: */ print(__METHOD__ . ':configEntry=' . $configEntry . ',configValue=' . $configValue . PHP_EOL);
                $this->config[$configEntry] = $configValue;
 
                // Resort the array
@@ -171,11 +198,14 @@ 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($configEntry)) {
                        // Entry was not found!
@@ -183,7 +213,7 @@ class FrameworkConfiguration implements Registerable {
                } // END - if
 
                // Unset it
-               unset($this->config[$configKey]);
+               unset($this->config[$configEntry]);
        }
 
        /**
@@ -331,6 +361,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
         *