New method detectServerAddress() added which should rewrite your code ito.

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

diff --git a/inc/config/class_FrameworkConfiguration.php b/inc/config/class_FrameworkConfiguration.php
index 5d47232ca4bdcee9f7b5d65303e1091125628ee3..283ad69a95b8cd8333345a77a2e519d9e2f65a79 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
  *
@@ -51,6 +51,15 @@ 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
         *
@@ -74,8 +83,8 @@ class FrameworkConfiguration implements Registerable {
         */
        public final function setDefaultTimezone ($zone) {
                // At least 5.1.0 is required for this!
-               if (version_compare(phpversion(), "5.1.0")) {
-                       @date_default_timezone_set($zone);
+               if (version_compare(phpversion(), '5.1.0')) {
+                       date_default_timezone_set($zone);
                } // END - if
        }
 
@@ -87,7 +96,7 @@ class FrameworkConfiguration implements Registerable {
                $enableQuotes = (boolean) $enableQuotes;
 
                // Set it
-               @set_magic_quotes_runtime($enableQuotes);
+               set_magic_quotes_runtime($enableQuotes);
        }
 
        /**
@@ -95,6 +104,8 @@ class FrameworkConfiguration implements Registerable {
         *
         * @param       $arrayObject    The array object with all include files
         * @return      void
+        * @deprecated
+        * @see         ClassLoader
         */
        private function loadIncludes (ArrayObject $arrayObject) {
                // Load only if there are includes defined
@@ -111,7 +122,7 @@ class FrameworkConfiguration implements Registerable {
                                        // Base path added? (Uni* / Windows)
                                        if ((substr($inc, 0, 1) != '/') && (substr($inc, 1, 1) != ':')) {
                                                // Generate FQFN
-                                               $fqfn = $this->readConfig('base_path') . '/inc/extra/' . $inc;
+                                               $fqfn = $this->getConfigEntry('base_path') . '/inc/extra/' . $inc;
                                        } // END - if
                                } // END - if
 
@@ -121,6 +132,20 @@ class FrameworkConfiguration implements Registerable {
                } // END - if
        }
 
+       /**
+        * Checks wether the given configuration entry is set
+        *
+        * @param       $configEntry    The configuration entry we shall check
+        * @return      $isset                  Wether the given configuration entry is set
+        */
+       protected function isConfigurationEntrySet ($configEntry) {
+               // Is it set?
+               $isset = isset($this->config[$configEntry]);
+
+               // Return the result
+               return $isset;
+       }
+
        /**
         * Read a configuration element.
         *
@@ -130,7 +155,7 @@ class FrameworkConfiguration implements Registerable {
         * @throws      ConfigEntryNotFoundException    If a configuration element
         *                                                                                      was not found
         */
-       public function readConfig ($cfgEntry) {
+       public function getConfigEntry ($cfgEntry) {
                // Cast to string
                $cfgEntry = (string) $cfgEntry;
 
@@ -138,7 +163,7 @@ 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->isConfigEntrySet($cfgEntry)) {
                        // Entry was not found!
                        throw new ConfigEntryNotFoundException(array(__CLASS__, $cfgEntry), self::EXCEPTION_CONFIG_ENTRY_WAS_NOT_FOUND);
                }
@@ -174,12 +199,76 @@ 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;
+       }
+
+       /**
+        * Setter for SERVER_ADDR
+        *
+        * @param       $serverAddress  New SERVER_ADDR value to set
+        * @return      void
+        */
+       public function setServerAddress ($serverAddress) {
+               $this->setConfigEntry('server_addr', (string) $serverAddress);
+       }
+
+       /**
+        * Getter for SERVER_ADDR
+        *
+        * @return      $serverAddress  New SERVER_ADDR value to set
+        */
+       public function getServerAddress () {
+               return $this->getConfigEntry('server_addr');
+       }
+
+       /**
+        * Detects the HTTPS flag
+        *
+        * @return      $https  The detected HTTPS flag or null if failed
+        */
+       public function detectHttpSecured () {
+               // Default is null
+               $https = null;
+
+               // Is HTTPS set?
+               if ($this->isHttpSecured()) {
+                       // Then use it
+                       $https = $_SERVER['HTTPS'];
+               } // END - if
+
+               // Return it
+               return $https;
+       }
+
+       /**
+        * Checks wether HTTPS is set in $_SERVER
+        *
+        * @return $isset       Wether HTTPS is set
+        */
+       public function isHttpSecured () {
+               return (isset($_SERVER['HTTPS']));
        }
 
        /**
@@ -187,12 +276,12 @@ class FrameworkConfiguration implements Registerable {
         *
         * @return      $baseUrl        Detected base URL
         */
-       public function detectBaseUrl() {
+       public function detectBaseUrl () {
                // Initialize the URL
                $baseUrl = 'http';
 
                // Do we have HTTPS?
-               if (isset($_SERVER['HTTPS'])) {
+               if ($this->isHttpSecured()) {
                        // Add the >s< for HTTPS
                        $baseUrl .= 's';
                } // END - if
@@ -253,7 +342,16 @@ class FrameworkConfiguration implements Registerable {
        public final function getField ($fieldName) {
                // Our super interface "FrameworkInterface" requires this
        }
+
+       /**
+        * Generates a code for hashes from this class
+        *
+        * @return      $hashCode       The hash code respresenting this class
+        */
+       public function hashCode () {
+               return crc32($this->__toString());
+       }
 }
 
-// [EOF]
+//
 ?>