Some more comments added, selfInstance rewritten to registryInstance
[core.git] / inc / classes / main / registry / class_Registry.php
index 9a8b648..243c2b4 100644 (file)
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, this is free software
+ * @copyright  Copyright (c) 2007 - 2009 Roland Haeder, this is free software
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -25,7 +25,7 @@ class Registry extends BaseFrameworkSystem implements Register {
        /**
         * Instance of this class
         */
-       private static $selfInstance = null;
+       private static $registryInstance = null;
 
        /**
         * Wether the registry is initialized
@@ -52,32 +52,37 @@ class Registry extends BaseFrameworkSystem implements Register {
        }
 
        /**
-        * Singleton getter for self instance
+        * Singleton getter for self instance. This class has no factory pattern
+        * because here is no need for special parameters.
         *
-        * @return      $selfInstance   Instance of this class
+        * @return      $registryInstance       Instance of this class
         */
        public final static function getRegistry () {
                // Is an instance there?
-               if (is_null(self::$selfInstance)) {
+               if (is_null(self::$registryInstance)) {
                        // Not yet, so create one
-                       self::$selfInstance = new Registry();
+                       self::$registryInstance = new Registry();
                }
 
                // Return the instance
-               return self::$selfInstance;
+               return self::$registryInstance;
        }
 
        /**
-        * Checks or sets wether the registry has been initialized. This had only be done once
+        * Checks or sets wether the registry has been initialized. This had only
+        * be done once.
         *
         * @param       $initialized    Wether the registry is initialized
         * @return      $initialized    Wether the registry is initialized
         */
        public final static function isInitialized ($initialized = null) {
+               // If no parameter (null by default) is provided we want to get the
+               // parameter. If set to e.g. "OK" then the registry is set to
+               // "initialized".
                if (is_null($initialized)) {
                        // Get status if initialized
                        return self::$initialized;
-               } elseif (!is_null($initialized)) {
+               } else {
                        // Registry is initialized!
                        self::$initialized = true;
                }