'public static final' is correct

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

diff --git a/inc/config/class_FrameworkConfiguration.php b/inc/config/class_FrameworkConfiguration.php
index 0494722ee770334cd03df4917af483e4718cedcb..6182aa3005881d5ce07f82be51161e7f3b3ae9b5 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, 2009 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -51,12 +51,21 @@ class FrameworkConfiguration implements Registerable {
                // Empty for now
        }
 
+       /**
+        * Compatiblity method to return this class' name
+        *
+        * @return      __CLASS__               This class' name
+        */
+       public function __toString () {
+               return get_class($this);
+       }
+
        /**
         * Getter for an instance of this class
         *
         * @return      $configInstance An instance of this class
         */
-       public final static function getInstance () {
+       public static final function getInstance () {
                // is the instance there?
                if (is_null(self::$configInstance))  {
                        // Create a config instance
@@ -91,36 +100,17 @@ class FrameworkConfiguration implements Registerable {
        }
 
        /**
-        * A private include loader
+        * Checks wether the given configuration entry is set
         *
-        * @param       $arrayObject    The array object with all include files
-        * @return      void
-        * @deprecated
-        * @see         ClassLoader
+        * @param       $configEntry    The configuration entry we shall check
+        * @return      $isset                  Wether the given configuration entry is set
         */
-       private function loadIncludes (ArrayObject $arrayObject) {
-               // Load only if there are includes defined
-               if (!is_null($arrayObject)) {
-                       for ($idx = $arrayObject->getIterator(); $idx->valid(); $idx->next()) {
-                               // Get include file
-                               $inc = $idx->current();
-
-                               // Is the file name really set?
-                               if (!empty($inc)) {
-                                       // Base path is by default added
-                                       $fqfn = $inc;
-
-                                       // Base path added? (Uni* / Windows)
-                                       if ((substr($inc, 0, 1) != '/') && (substr($inc, 1, 1) != ':')) {
-                                               // Generate FQFN
-                                               $fqfn = $this->getConfigEntry('base_path') . '/inc/extra/' . $inc;
-                                       } // END - if
-                               } // END - if
-
-                               // Include them all here
-                               require($fqfn);
-                       }
-               } // END - if
+       protected function isConfigurationEntrySet ($configEntry) {
+               // Is it set?
+               $isset = isset($this->config[$configEntry]);
+
+               // Return the result
+               return $isset;
        }
 
        /**
@@ -129,7 +119,7 @@ class FrameworkConfiguration implements Registerable {
         * @param       $cfgEntry       The configuration element
         * @return      $cfgValue       The fetched configuration value
         * @throws      ConfigEntryIsEmptyException             If $cfgEntry is empty
-        * @throws      ConfigEntryNotFoundException    If a configuration element
+        * @throws      NoConfigEntryException  If a configuration element
         *                                                                                      was not found
         */
        public function getConfigEntry ($cfgEntry) {
@@ -140,9 +130,9 @@ class FrameworkConfiguration implements Registerable {
                if (empty($cfgEntry)) {
                        // Entry is empty
                        throw new ConfigEntryIsEmptyException($this, self::EXCEPTION_CONFIG_ENTRY_IS_EMPTY);
-               } elseif (!isset($this->config[$cfgEntry])) {
+               } elseif (!$this->isConfigurationEntrySet($cfgEntry)) {
                        // Entry was not found!
-                       throw new ConfigEntryNotFoundException(array(__CLASS__, $cfgEntry), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND);
+                       throw new NoConfigEntryException(array(__CLASS__, $cfgEntry), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND);
                }
 
                // Return the requested value
@@ -176,12 +166,29 @@ class FrameworkConfiguration implements Registerable {
        }
 
        /**
-        * Compatiblity method to return this class' name
+        * Detects the server address (SERVER_ADDR) and set it in configuration
         *
-        * @return      __CLASS__               This class' name
+        * @return      $serverAddress  The detected server address
+        * @todo        We have to add some more entries from $_SERVER here
         */
-       public function __toString () {
-               return get_class($this);
+       public function detectServerAddress () {
+               // Is the entry set?
+               if (!$this->isConfigurationEntrySet('server_addr')) {
+                       // Is it set in $_SERVER?
+                       if (isset($_SERVER['SERVER_ADDR'])) {
+                               // Set it from $_SERVER
+                               $this->setServerAddress($_SERVER['SERVER_ADDR']);
+                       } elseif (class_exists('ConsoleTools')) {
+                               // Run auto-detecting through console tools lib
+                               ConsoleTools::acquireSelfIPAddress();
+                       }
+               } // END - if
+
+               // Now get it from configuration
+               $serverAddress = $this->getServerAddress();
+
+               // Return it
+               return $serverAddress;
        }
 
        /**