5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class BaseRegistry extends BaseFrameworkSystem implements Registerable {
26 * Glue for generating a registry key
28 const REGISTRY_KEY_GLUE = '_';
31 * Instance of this class
33 private static $registryInstance = NULL;
36 * Protected constructor
38 * @param $className Name of the class
41 protected function __construct ($className) {
42 // Call parent constructor
43 parent::__construct($className);
46 $this->initGenericArrayGroup('raw', 'generic');
50 * Checks whether an instance key was found
52 * @param $instanceKey The key holding an instance in registry
53 * @return $exists Whether the key exists in registry
55 public function instanceExists ($instanceKey) {
56 // Does this key exists?
57 $exists = $this->isGenericArrayKeySet('registry', 'instance', $instanceKey);
64 * Adds/overwrites a new instance to the registry at the given key
66 * @param $instanceKey The key to identify the instance
67 * @param $objectInstance An instance we shall store
70 public function addInstance ($instanceKey, Registerable $objectInstance) {
71 $this->setGenericArrayKey('registry', 'instance', $instanceKey, $objectInstance);
75 * Getter for whole instance registry
77 * @return $instanceRegistry The whole instance registry array
79 public final function getInstanceRegistry () {
80 return $this->getGenericSubArray('registry', 'instance');
84 * Adds a new entry to the given list name. If you want to add objects
85 * please use addInstance() and getInstance() instead.
87 * @param $key The key to identify the whole list
88 * @param $value The value to be stored
91 public final function addEntry ($key, $value) {
92 // Key must not be an array
93 assert(!is_array($key));
96 $this->pushValueToGenericArrayKey('raw', 'generic', $key, $value);
100 * Getter for entries or "sub entries"
102 * @return $entries An array with entries from this registry
104 public final function getEntries ($key = NULL) {
105 // Key must not be an array
106 assert(!is_array($key));
108 // Default is whole array
109 $entries = $this->getGenericArray('raw');
112 if (!is_null($key)) {
113 // Then use this entry
114 $entries = $this->getGenericArrayKey('raw', 'generic', $key);
122 * "Getter" for an array of all entries for given key
124 * @param $arrayKey The array (key) to look in
125 * @param $lookFor The key to look for
126 * @return $entry An array with all keys
128 public function getArrayFromKey ($arrayKey, $lookFor) {
129 // Key must not be an array
130 assert(!is_array($arrayKey));
136 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REGISTRY[' . __METHOD__ . ':' . __LINE__ . ']: Checking arrayKey=' . $arrayKey . ',lookFor=' . $lookFor);
138 // "Walk" over all entries
139 foreach ($this->getEntries($arrayKey) as $key => $value) {
141 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REGISTRY[' . __METHOD__ . ':' . __LINE__ . ']: Checking key=' . $key . ',value=' . $value . ',lookFor=' . $lookFor);
143 // If $value matches the $lookFor, we need to look for more entries for this!
144 if ($lookFor == $value) {
145 // Look for more entries
146 foreach ($this->getEntries() as $key2 => $value2) {
147 // Now "walk" through all entries, if an array is returned
148 if (is_array($value2)) {
150 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REGISTRY[' . __METHOD__ . ':' . __LINE__ . ']: Checking key2=' . $key2 . ',value2()=' . count($value2) . ',lookFor=' . $lookFor);
152 // "Walk" through all of them
153 foreach ($value2 as $key3 => $value3) {
154 // $value3 needs to be an array
155 assert(is_array($value3));
158 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REGISTRY[' . __METHOD__ . ':' . __LINE__ . ']: Checking key=' . $key . ',key3=' . $key3 . ',isset()=' . isset($value3[$key]) . ' ...');
160 // Both keys must match!
161 if (($key == $key3) || (isset($value3[$key]))) {
163 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REGISTRY[' . __METHOD__ . ':' . __LINE__ . ']: Adding ' . $value3[$key] . ' ...');
166 $entry[$key3] = $value3[$key];
172 // Skip further lookups
178 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REGISTRY[' . __METHOD__ . ':' . __LINE__ . ']: Returning entry(' . count($entry) . ')=' . print_r($entry, TRUE));
185 * Gets a registered instance or null if not found
187 * @param $instanceKey The key to identify the instance
188 * @return $objectInstance An instance we shall store
189 * @throws NullPointerException If the requested key is not found
191 public function getInstance ($instanceKey) {
192 // Is the instance there?
193 if (!$this->instanceExists($instanceKey)) {
194 // This might happen if a non-registered key was requested
195 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
199 $objectInstance = $this->getGenericArrayKey('registry', 'instance', $instanceKey);
202 return $objectInstance;
206 * "Getter" for a registry key for given prefix and array. This method
207 * calls implode() to get a suitable key. This method does not care about
210 * @param $prefix Prefix for the key
211 * @param $data An array with data
212 * @return $registryKey A registry key
214 public static function getRegistryKeyFromArray ($prefix, array $data) {
215 // "Generate" the key
216 $registryKey = $prefix . self::REGISTRY_KEY_GLUE . implode(self::REGISTRY_KEY_GLUE, $data);