Removed deprecated scripts (please delete them even if you get conflicts)

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

diff --git a/inc/config/class_FrameworkConfiguration.php b/inc/config/class_FrameworkConfiguration.php
index f37194d94aaa8abcbf9928cb5782cfce6985646b..bebc1cdea119be80780ad8f1d25e93c9a13ba513 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 - 2011 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 $configInstance = null;
+       private static $configInstance = NULL;
 
        // Some constants for the configuration system
        const EXCEPTION_CONFIG_ENTRY_IS_EMPTY      = 0x130;
@@ -65,7 +65,7 @@ class FrameworkConfiguration implements Registerable {
         *
         * @return      $configInstance An instance of this class
         */
-       public final static function getInstance () {
+       public static final function getSelfInstance () {
                // is the instance there?
                if (is_null(self::$configInstance))  {
                        // Create a config instance
@@ -78,7 +78,7 @@ class FrameworkConfiguration implements Registerable {
        /**
         * Setter for default time zone (must be correct!)
         *
-        * @param               $zone   The time-zone string (e.g. Europe/Berlin)
+        * @param       $zone   The time-zone string (e.g. Europe/Berlin)
         * @return      void
         */
        public final function setDefaultTimezone ($zone) {
@@ -90,6 +90,9 @@ class FrameworkConfiguration implements Registerable {
 
        /**
         * Setter for runtime magic quotes
+        *
+        * @param       $enableQuotes   Whether enable magic runtime quotes (should be disabled for security reasons)
+        * @return      void
         */
        public final function setMagicQuotesRuntime ($enableQuotes) {
                // Cast it to boolean
@@ -100,10 +103,10 @@ class FrameworkConfiguration implements Registerable {
        }
 
        /**
-        * Checks wether the given configuration entry is set
+        * Checks whether the given configuration entry is set
         *
         * @param       $configEntry    The configuration entry we shall check
-        * @return      $isset                  Wether the given configuration entry is set
+        * @return      $isset                  Whether the given configuration entry is set
         */
        protected function isConfigurationEntrySet ($configEntry) {
                // Is it set?
@@ -217,7 +220,7 @@ class FrameworkConfiguration implements Registerable {
         */
        public function detectHttpSecured () {
                // Default is null
-               $https = null;
+               $https = NULL;
 
                // Is HTTPS set?
                if ($this->isHttpSecured()) {
@@ -230,9 +233,9 @@ class FrameworkConfiguration implements Registerable {
        }
 
        /**
-        * Checks wether HTTPS is set in $_SERVER
+        * Checks whether HTTPS is set in $_SERVER
         *
-        * @return $isset       Wether HTTPS is set
+        * @return $isset       Whether HTTPS is set
         */
        public function isHttpSecured () {
                return (isset($_SERVER['HTTPS']));
@@ -318,7 +321,26 @@ class FrameworkConfiguration implements Registerable {
        public function hashCode () {
                return crc32($this->__toString());
        }
+
+       /**
+        * Checks whether an object equals this object. You should overwrite this
+        * method to implement own equality checks
+        *
+        * @param       $objectInstance         An instance of a FrameworkInterface object
+        * @return      $equals                         Whether both objects equals
+        */
+       public function equals (FrameworkInterface $objectInstance) {
+               // Now test it
+               $equals = ((
+                       $this->__toString() == $objectInstance->__toString()
+               ) && (
+                       $this->hashCode() == $objectInstance->hashCode()
+               ));
+
+               // Return the result
+               return $equals;
+       }
 }
 
-//
+// [EOF]
 ?>