Added line number to debug lines as this will become the default

[core.git] / inc / classes / main / registry / class_BaseRegistry.php

diff --git a/inc/classes/main/registry/class_BaseRegistry.php b/inc/classes/main/registry/class_BaseRegistry.php
index 6330331d46b1b8fb983cc7eb8ccd4f7d83175be2..4fd9aaf6dd5b022b2d3f1d80a0aa477b0617bacd 100644 (file)
--- a/inc/classes/main/registry/class_BaseRegistry.php
+++ b/inc/classes/main/registry/class_BaseRegistry.php
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -22,10 +22,15 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 class BaseRegistry extends BaseFrameworkSystem implements Registerable {
+       /**
+        * Glue for generating a registry key
+        */
+       const REGISTRY_KEY_GLUE = '_';
+
        /**
         * Instance of this class
         */
-       private static $registryInstance = null;
+       private static $registryInstance = NULL;
 
        /**
         * Instance registry
@@ -49,10 +54,10 @@ class BaseRegistry extends BaseFrameworkSystem implements Registerable {
        }
 
        /**
-        * Checks wether an instance key was found
+        * Checks whether an instance key was found
         *
         * @param       $instanceKey    The key holding an instance in registry
-        * @return      $exists                 Wether the key exists in registry
+        * @return      $exists                 Whether the key exists in registry
         */
        public function instanceExists ($instanceKey) {
                // Does this key exists?
@@ -74,7 +79,7 @@ class BaseRegistry extends BaseFrameworkSystem implements Registerable {
        }
 
        /**
-        * Getter for whole instanceregistry
+        * Getter for whole instance registry
         *
         * @return      $instanceRegistry       The whole instance registry array
         */
@@ -100,7 +105,7 @@ class BaseRegistry extends BaseFrameworkSystem implements Registerable {
         *
         * @return      $entries        An array with entries from this registry
         */
-       public final function getEntries ($key = null) {
+       public final function getEntries ($key = NULL) {
                // Default is whole array
                $entries = $this->rawEntries;
 
@@ -117,29 +122,30 @@ class BaseRegistry extends BaseFrameworkSystem implements Registerable {
        /**
         * "Getter" for an array of all entries for given key
         *
+        * @param       $arrayKey       The array (key) to look in
         * @param       $lookFor        The key to look for
         * @return      $entry          An array with all keys
         */
-       public function getArrayFromKey ($lookFor) {
+       public function getArrayFromKey ($arrayKey, $lookFor) {
                // Init array
                $entry = array();
 
                // "Walk" over all entries
-               foreach ($this->getEntries('object-name') as $key=>$value) {
+               foreach ($this->getEntries($arrayKey) as $key => $value) {
                        // Debug message
-                       //* DEBUG: */ $this->debugOutput('REGISTRY: Checking key=' . $key . ',value=' . $value . ',lookFor=' . $lookFor);
+                       //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REGISTRY[' . __LINE__ . ']: Checking key=' . $key . ',value=' . $value . ',lookFor=' . $lookFor);
 
                        // If $value matches the $lookFor, we need to look for more entries for this!
                        if ($lookFor == $value) {
                                // Look for more entries
-                               foreach ($this->getEntries() as $key2=>$value2) {
+                               foreach ($this->getEntries() as $key2 => $value2) {
                                        // Debug message
-                                       //* DEBUG: */ $this->debugOutput('REGISTRY: Checking key2=' . $key2 . ',value2=' . print_r($value2, true) . ',lookFor=' . $lookFor);
+                                       //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REGISTRY[' . __LINE__ . ']: Checking key2=' . $key2 . ',value2=' . print_r($value2, true) . ',lookFor=' . $lookFor);
 
                                        // Both keys must match!
                                        if (($key == $key2) || (isset($value2[$key]))) {
                                                // Debug message
-                                               //* DEBUG: */ $this->debugOutput('REGISTRY: Adding ' . $value2[$key] . ' ...');
+                                               //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REGISTRY[' . __LINE__ . ']: Adding ' . $value2[$key] . ' ...');
 
                                                // Then add it
                                                $entry[$key2] = $value2[$key];
@@ -163,23 +169,35 @@ class BaseRegistry extends BaseFrameworkSystem implements Registerable {
         * @throws      NullPointerException    If the requested key is not found
         */
        public function getInstance ($instanceKey) {
-               // By default the instance is not in registry
-               $objectInstance = null;
-
                // Is the instance there?
-               if ($this->instanceExists($instanceKey)) {
-                       $objectInstance = $this->instanceRegistry[$instanceKey];
-               } // END - if
-
-               // Still not fetched?
-               if (is_null($objectInstance)) {
+               if (!$this->instanceExists($instanceKey)) {
                        // This might happen if a non-registered key was requested
                        throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
                } // END - if
 
+               // Get the instance
+               $objectInstance = $this->instanceRegistry[$instanceKey];
+
                // Return the result
                return $objectInstance;
        }
+
+       /**
+        * "Getter" for a registry key for given prefix and array. This method
+        * calls implode() to get a suitable key. This method does not care about
+        * the indexes.
+        *
+        * @param       $prefix                 Prefix for the key
+        * @param       $data                   An array with data
+        * @return      $registryKey    A registry key
+        */
+       public static function getRegistryKeyFromArray ($prefix, array $data) {
+               // "Generate" the key
+               $registryKey = $prefix . self::REGISTRY_KEY_GLUE . implode(self::REGISTRY_KEY_GLUE, $data);
+
+               // Return it
+               return $registryKey;
+       }
 }
 
 // [EOF]