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 28f0c0a6786852b7004dd4d0c1443e1b46b29dff..fafc68fd21c9f3aa07c20f88fc5e4546eece5d28 100644 (file)
--- a/inc/config/class_FrameworkConfiguration.php
+++ b/inc/config/class_FrameworkConfiguration.php
@@ -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;
        }
 
        /**
@@ -231,6 +231,8 @@ class FrameworkConfiguration implements Registerable {
        /**
         * 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
@@ -245,6 +247,17 @@ class FrameworkConfiguration implements Registerable {
                // Return it
                return $scriptPath;
        }
+
+       /**
+        * Getter for field name
+        *
+        * @param       $fieldName              Field name which we shall get
+        * @return      $fieldValue             Field value from the user
+        * @throws      NullPointerException    If the result instance is null
+        */
+       public final function getField ($fieldName) {
+               // Our super interface "FrameworkInterface" requires this
+       }
 }
 
 // [EOF]