Misc fixes/code cleanups

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

diff --git a/inc/config/class_FrameworkConfiguration.php b/inc/config/class_FrameworkConfiguration.php
index 28f0c0a6786852b7004dd4d0c1443e1b46b29dff..85da3032725ef2bad673906d1d7e45aea99252a1 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 - 2009 Roland Haeder, this is free software
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
  * @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;
        }
 
        /**
@@ -109,9 +109,9 @@ class FrameworkConfiguration implements Registerable {
                                        $fqfn = $inc;
 
                                        // Base path added? (Uni* / Windows)
-                                       if ((substr($inc, 0, 1) != "/") && (substr($inc, 1, 1) != ":")) {
+                                       if ((substr($inc, 0, 1) != '/') && (substr($inc, 1, 1) != ':')) {
                                                // Generate FQFN
-                                               $fqfn = sprintf("%s/inc/extra/%s", $this->readConfig('base_path'), $inc);
+                                               $fqfn = $this->readConfig('base_path') . '/inc/extra/' . $inc;
                                        } // END - if
                                } // END - if
 
@@ -143,11 +143,6 @@ class FrameworkConfiguration implements Registerable {
                        throw new ConfigEntryNotFoundException(array(__CLASS__, $cfgEntry), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND);
                }
 
-               // Debug message
-               if ((defined('DEBUG_CONFIG')) || (defined('DEBUG_ALL'))) {
-                       echo "[".__METHOD__."] Configuration entry ".$cfgEntry." requested.<br />\n";
-               } // END - if
-
                // Return the requested value
                return $this->config[$cfgEntry];
        }
@@ -194,16 +189,16 @@ class FrameworkConfiguration implements Registerable {
         */
        public function detectBaseUrl() {
                // Initialize the URL
-               $baseUrl = "http";
+               $baseUrl = 'http';
 
                // Do we have HTTPS?
                if (isset($_SERVER['HTTPS'])) {
                        // Add the >s< for HTTPS
-                       $baseUrl .= "s";
+                       $baseUrl .= 's';
                } // END - if
 
-               // Construct the full URL now and secure it against CSRF attacks
-               $baseUrl = $baseUrl . "://" . $this->detectDomain() . $this->detectScriptPath();
+               // Construct the full URL and secure it against CSRF attacks
+               $baseUrl = $baseUrl . '://' . $this->detectDomain() . $this->detectScriptPath();
 
                // Return the URL
                return $baseUrl;
@@ -216,7 +211,7 @@ class FrameworkConfiguration implements Registerable {
         */
        public function detectDomain () {
                // Full domain is localnet.invalid by default
-               $fullDomain = "localnet.invalid";
+               $fullDomain = 'localnet.invalid';
 
                // Is the server name there?
                if (isset($_SERVER['SERVER_NAME'])) {
@@ -231,20 +226,33 @@ 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
-               $scriptPath = "";
+               $scriptPath = '';
 
                // Is the scriptname set?
                if (isset($_SERVER['SCRIPT_NAME'])) {
                        // Get dirname from it and replace back-slashes with slashes for lame OSes...
-                       $scriptPath = str_replace("\\", "/", dirname($_SERVER['SCRIPT_NAME']));
+                       $scriptPath = str_replace("\\", '/', dirname($_SERVER['SCRIPT_NAME']));
                } // END - if
 
                // 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]