*
* @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
*
*/
class BaseRegistry extends BaseFrameworkSystem implements Registerable {
/**
- * Instance of this class
+ * Glue for generating a registry key
*/
- private static $registryInstance = NULL;
+ const REGISTRY_KEY_GLUE = '_';
/**
- * Instance registry
- */
- private $instanceRegistry = array();
-
- /**
- * Raw data entries (non-objects)
+ * Instance of this class
*/
- private $rawEntries = array();
+ private static $registryInstance = NULL;
/**
* Protected constructor
*/
public function instanceExists ($instanceKey) {
// Does this key exists?
- $exists = (isset($this->instanceRegistry[$instanceKey]));
+ $exists = $this->isGenericArrayKeySet('registry', 'instance', $instanceKey);
// Return the result
return $exists;
* @return void
*/
public function addInstance ($instanceKey, Registerable $objectInstance) {
- $this->instanceRegistry[$instanceKey] = $objectInstance;
+ $this->setGenericArrayKey('registry', 'instance', $instanceKey, $objectInstance);
}
/**
* @return $instanceRegistry The whole instance registry array
*/
public final function getInstanceRegistry () {
- return $this->instanceRegistry;
+ return $this->getGenericSubArray('registry', 'instance');
}
/**
* @return void
*/
public final function addEntry ($key, $value) {
- // Simply add it
- $this->rawEntries[$key][] = $value;
+ // Key must not be an array
+ assert(!is_array($key));
+
+ // Push it
+ $this->pushValueToGenericArrayElement('raw', 'generic', $key, $value);
}
/**
* @return $entries An array with entries from this registry
*/
public final function getEntries ($key = NULL) {
+ // Key must not be an array
+ assert(!is_array($key));
+
// Default is whole array
- $entries = $this->rawEntries;
+ $entries = $this->getGenericArray('raw');
// Is $key set?
if (!is_null($key)) {
// Then use this entry
- $entries = $this->rawEntries[$key];
+ $entries = $this->getGenericArrayKey('raw', 'generic', $key);
} // END - if
// Return the array
/**
* "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) {
+ // Key must not be an array
+ assert(!is_array($arrayKey));
+
// Init array
$entry = array();
+ // Debug message
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REGISTRY[' . __LINE__ . ']: Checking arrayKey=' . $arrayKey . ',lookFor=' . $lookFor);
+
// "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) {
- // 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]))) {
+ foreach ($this->getEntries() as $key2 => $value2) {
+ // Now "walk" through all entries, if an array is returned
+ if (is_array($value2)) {
// Debug message
- //* DEBUG: */ $this->debugOutput('REGISTRY: Adding ' . $value2[$key] . ' ...');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REGISTRY[' . __LINE__ . ']: Checking key2=' . $key2 . ',value2()=' . count($value2) . ',lookFor=' . $lookFor);
+
+ // "Walk" through all of them
+ foreach ($value2 as $key3 => $value3) {
+ // $value3 needs to be an array
+ assert(is_array($value3));
+
+ // Debug message
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REGISTRY[' . __LINE__ . ']: Checking key=' . $key . ',key3=' . $key3 . ',isset()=' . isset($value3[$key]) . ' ...');
- // Then add it
- $entry[$key2] = $value2[$key];
+ // Both keys must match!
+ if (($key == $key3) || (isset($value3[$key]))) {
+ // Debug message
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REGISTRY[' . __LINE__ . ']: Adding ' . $value3[$key] . ' ...');
+
+ // Then add it
+ $entry[$key3] = $value3[$key];
+ } // END - if
+ } // END - foreach
} // END - if
} // END - foreach
} // END - if
} // END - foreach
+ // Debug message
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REGISTRY[' . __LINE__ . ']: Returning entry(' . count($entry) . ')=' . print_r($entry, TRUE));
+
// Return it
return $entry;
}
* @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->getGenericArrayKey('registry', 'instance', $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]
projects / core.git / blobdiff