And 'public' also ...

[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 0cf9aeb45a4ec486c65bbcc5b20b38c7d14abf52..84b6d63ba7a7971ecd8a6487d00f8c35f6852a6b 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
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0

- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 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
  *
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *


@@ -21,17 +21,27 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */

-class BaseRegistry extends BaseFrameworkSystem {
+class BaseRegistry extends BaseFrameworkSystem implements Registerable {
+       /**
+        * Glue for generating a registry key
+        */
+       const REGISTRY_KEY_GLUE = '_';
+

        /**
         * Instance of this class
         */
        /**
         * Instance of this class
         */

-       private static $registryInstance = null;
+       private static $registryInstance = NULL;

 
        /**
         * Instance registry
         */
        private $instanceRegistry = array();
 
 
        /**
         * Instance registry
         */
        private $instanceRegistry = array();
 

+       /**
+        * Raw data entries (non-objects)
+        */
+       private $rawEntries = array();
+

        /**
         * Protected constructor
         *
        /**
         * Protected constructor
         *


@@ -44,10 +54,10 @@ class BaseRegistry extends BaseFrameworkSystem {
        }
 
        /**
        }
 
        /**

-        * Checks wether an instance key was found
+        * Checks whether an instance key was found

         *
         * @param       $instanceKey    The key holding an instance in registry
         *
         * @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?
         */
        public function instanceExists ($instanceKey) {
                // Does this key exists?


@@ -68,6 +78,88 @@ class BaseRegistry extends BaseFrameworkSystem {
                $this->instanceRegistry[$instanceKey] = $objectInstance;
        }
 
                $this->instanceRegistry[$instanceKey] = $objectInstance;
        }
 

+       /**
+        * Getter for whole instance registry
+        *
+        * @return      $instanceRegistry       The whole instance registry array
+        */
+       public final function getInstanceRegistry () {
+               return $this->instanceRegistry;
+       }
+
+       /**
+        * Adds a new entry to the given list name. If you want to add objects
+        * please use addInstance() and getInstance() instead.
+        *
+        * @param       $key    The key to identify the whole list
+        * @param       $value  The value to be stored
+        * @return      void
+        */
+       public final function addEntry ($key, $value) {
+               // Simply add it
+               $this->rawEntries[$key][] = $value;
+       }
+
+       /**
+        * Getter for entries or "sub entries"
+        *
+        * @return      $entries        An array with entries from this registry
+        */
+       public final function getEntries ($key = NULL) {
+               // Default is whole array
+               $entries = $this->rawEntries;
+
+               // Is $key set?
+               if (!is_null($key)) {
+                       // Then use this entry
+                       $entries = $this->rawEntries[$key];
+               } // END - if
+
+               // Return the array
+               return $entries;
+       }
+
+       /**
+        * "Getter" for an array of all entries for given key
+        *
+        * @param       $lookFor        The key to look for
+        * @return      $entry          An array with all keys
+        */
+       public function getArrayFromKey ($lookFor) {
+               // Init array
+               $entry = array();
+
+               // "Walk" over all entries
+               foreach ($this->getEntries('object-name') as $key=>$value) {
+                       // Debug message
+                       //* DEBUG: */ $this->debugOutput('REGISTRY: 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) {
+                                       // Debug message
+                                       //* DEBUG: */ $this->debugOutput('REGISTRY: 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] . ' ...');
+
+                                               // Then add it
+                                               $entry[$key2] = $value2[$key];
+                                       } // END - if
+                               } // END - foreach
+
+                               // Skip further lookups
+                               break;
+                       } // END - if
+               } // END - foreach
+
+               // Return it
+               return $entry;
+       }
+

        /**
         * Gets a registered instance or null if not found
         *
        /**
         * Gets a registered instance or null if not found
         *


@@ -77,7 +169,7 @@ class BaseRegistry extends BaseFrameworkSystem {
         */
        public function getInstance ($instanceKey) {
                // By default the instance is not in registry
         */
        public function getInstance ($instanceKey) {
                // By default the instance is not in registry

-               $objectInstance = null;
+               $objectInstance = NULL;

 
                // Is the instance there?
                if ($this->instanceExists($instanceKey)) {
 
                // Is the instance there?
                if ($this->instanceExists($instanceKey)) {


@@ -93,8 +185,24 @@ class BaseRegistry extends BaseFrameworkSystem {
                // Return the result
                return $objectInstance;
        }
                // 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]
 ?>
 }
 
 // [EOF]
 ?>

-