And 'public' also ...
[core.git] / inc / classes / main / registry / class_BaseRegistry.php
index 6330331d46b1b8fb983cc7eb8ccd4f7d83175be2..84b6d63ba7a7971ecd8a6487d00f8c35f6852a6b 100644 (file)
  * 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;
 
@@ -164,7 +169,7 @@ class BaseRegistry extends BaseFrameworkSystem implements Registerable {
         */
        public function getInstance ($instanceKey) {
                // By default the instance is not in registry
-               $objectInstance = null;
+               $objectInstance = NULL;
 
                // Is the instance there?
                if ($this->instanceExists($instanceKey)) {
@@ -180,6 +185,23 @@ class BaseRegistry extends BaseFrameworkSystem implements Registerable {
                // 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]