Now all cfgInstance are rewritten to configInstance

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

diff --git a/inc/config/class_FrameworkConfiguration.php b/inc/config/class_FrameworkConfiguration.php
index e3202603aba1317a735a0bfbf02dcc37b2206f3a..fafc68fd21c9f3aa07c20f88fc5e4546eece5d28 100644 (file)
--- a/inc/config/class_FrameworkConfiguration.php
+++ b/inc/config/class_FrameworkConfiguration.php
@@ -8,7 +8,7 @@
  * @see                        ClassLoader
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, this is free software
+ * @copyright  Copyright (c) 2007 - 2009 Roland Haeder, this is free software
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -36,7 +36,7 @@ class FrameworkConfiguration implements Registerable {
        /**
         * The configuration instance itself
         */
-       private static $cfgInstance = null;
+       private static $configInstance = null;
 
        // Some constants for the configuration system
        const EXCEPTION_CONFIG_ENTRY_IS_EMPTY      = 0x130;
@@ -54,16 +54,16 @@ class FrameworkConfiguration implements Registerable {
        /**
         * Getter for an instance of this class
         *
-        * @return      $cfgInstance    An instance of this class
+        * @return      $configInstance An instance of this class
         */
        public final static function getInstance () {
                // is the instance there?
-               if (is_null(self::$cfgInstance))  {
+               if (is_null(self::$configInstance))  {
                        // Create a config instance
-                       self::$cfgInstance = new FrameworkConfiguration();
+                       self::$configInstance = new FrameworkConfiguration();
                } // END - if
 
-               return self::$cfgInstance;
+               return self::$configInstance;
        }
 
        /**
@@ -229,8 +229,10 @@ class FrameworkConfiguration implements Registerable {
        }
 
        /**
-        * Detect safely the script path without trailing slash which is the part
+        * Detect safely the script path without trailing slash which is the glue
         * between "http://your-domain.invalid/" and "script-name.php"
+        *
+        * @return      $scriptPath             The script path extracted from $_SERVER['SCRIPT_NAME']
         */
        public function detectScriptPath () {
                // Default is empty
@@ -238,8 +240,8 @@ class FrameworkConfiguration implements Registerable {
 
                // Is the scriptname set?
                if (isset($_SERVER['SCRIPT_NAME'])) {
-                       // Get dirname of it
-                       $scriptPath = dirname($_SERVER['SCRIPT_NAME']);
+                       // Get dirname from it and replace back-slashes with slashes for lame OSes...
+                       $scriptPath = str_replace("\\", "/", dirname($_SERVER['SCRIPT_NAME']));
                } // END - if
 
                // Return it
@@ -251,20 +253,10 @@ class FrameworkConfiguration implements Registerable {
         *
         * @param       $fieldName              Field name which we shall get
         * @return      $fieldValue             Field value from the user
+        * @throws      NullPointerException    If the result instance is null
         */
-       function getField ($fieldName) {
-               // Dummy method!
-       }
-
-       /**
-        * Updates a given field with new value
-        *
-        * @param       $fieldName              Field to update
-        * @param       $fieldValue             New value to store
-        * @return      void
-        */
-       public function updateDatabaseField ($fieldName, $fieldValue) {
-               // Dummy method!
+       public final function getField ($fieldName) {
+               // Our super interface "FrameworkInterface" requires this
        }
 }