3 namespace CoreFramework\Registry;
5 // Import framework stuff
6 use CoreFramework\Object\BaseFrameworkSystem;
11 * @author Roland Haeder <webmaster@shipsimu.org>
13 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
14 * @license GNU GPL 3.0 or any newer version
15 * @link http://www.shipsimu.org
17 * This program is free software: you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation, either version 3 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 class BaseRegistry extends BaseFrameworkSystem implements Registerable {
32 * Glue for generating a registry key
34 const REGISTRY_KEY_GLUE = '_';
37 * Instance of this class
39 private static $registryInstance = NULL;
42 * Protected constructor
44 * @param $className Name of the class
47 protected function __construct ($className) {
48 // Call parent constructor
49 parent::__construct($className);
52 $this->initGenericArrayGroup('raw', 'generic');
56 * Checks whether an instance key was found
58 * @param $instanceKey The key holding an instance in registry
59 * @return $exists Whether the key exists in registry
61 public function instanceExists ($instanceKey) {
62 // Does this key exists?
63 $exists = $this->isGenericArrayKeySet('registry', 'instance', $instanceKey);
70 * Adds/overwrites a new instance to the registry at the given key
72 * @param $instanceKey The key to identify the instance
73 * @param $objectInstance An instance we shall store
76 public function addInstance ($instanceKey, Registerable $objectInstance) {
77 $this->setGenericArrayKey('registry', 'instance', $instanceKey, $objectInstance);
81 * Getter for whole instance registry
83 * @return $instanceRegistry The whole instance registry array
85 public final function getInstanceRegistry () {
86 return $this->getGenericSubArray('registry', 'instance');
90 * Adds a new entry to the given list name. If you want to add objects
91 * please use addInstance() and getInstance() instead.
93 * @param $key The key to identify the whole list
94 * @param $value The value to be stored
97 public final function addEntry ($key, $value) {
98 // Key must not be an array
99 assert(!is_array($key));
102 $this->pushValueToGenericArrayKey('raw', 'generic', $key, $value);
106 * Getter for entries or "sub entries"
108 * @return $entries An array with entries from this registry
110 public final function getEntries ($key = NULL) {
111 // Key must not be an array
112 assert(!is_array($key));
114 // Default is whole array
115 $entries = $this->getGenericArray('raw');
118 if (!is_null($key)) {
119 // Then use this entry
120 $entries = $this->getGenericArrayKey('raw', 'generic', $key);
128 * "Getter" for an array of all entries for given key
130 * @param $arrayKey The array (key) to look in
131 * @param $lookFor The key to look for
132 * @return $entry An array with all keys
134 public function getArrayFromKey ($arrayKey, $lookFor) {
135 // Key must not be an array
136 assert(!is_array($arrayKey));
142 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REGISTRY[' . __METHOD__ . ':' . __LINE__ . ']: Checking arrayKey=' . $arrayKey . ',lookFor=' . $lookFor);
144 // "Walk" over all entries
145 foreach ($this->getEntries($arrayKey) as $key => $value) {
147 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REGISTRY[' . __METHOD__ . ':' . __LINE__ . ']: Checking key=' . $key . ',value=' . $value . ',lookFor=' . $lookFor);
149 // If $value matches the $lookFor, we need to look for more entries for this!
150 if ($lookFor == $value) {
151 // Look for more entries
152 foreach ($this->getEntries() as $key2 => $value2) {
153 // Now "walk" through all entries, if an array is returned
154 if (is_array($value2)) {
156 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REGISTRY[' . __METHOD__ . ':' . __LINE__ . ']: Checking key2=' . $key2 . ',value2()=' . count($value2) . ',lookFor=' . $lookFor);
158 // "Walk" through all of them
159 foreach ($value2 as $key3 => $value3) {
160 // $value3 needs to be an array
161 assert(is_array($value3));
164 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REGISTRY[' . __METHOD__ . ':' . __LINE__ . ']: Checking key=' . $key . ',key3=' . $key3 . ',isset()=' . isset($value3[$key]) . ' ...');
166 // Both keys must match!
167 if (($key == $key3) || (isset($value3[$key]))) {
169 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REGISTRY[' . __METHOD__ . ':' . __LINE__ . ']: Adding ' . $value3[$key] . ' ...');
172 $entry[$key3] = $value3[$key];
178 // Skip further lookups
184 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REGISTRY[' . __METHOD__ . ':' . __LINE__ . ']: Returning entry(' . count($entry) . ')=' . print_r($entry, TRUE));
191 * Gets a registered instance or null if not found
193 * @param $instanceKey The key to identify the instance
194 * @return $objectInstance An instance we shall store
195 * @throws NullPointerException If the requested key is not found
197 public function getInstance ($instanceKey) {
198 // Is the instance there?
199 if (!$this->instanceExists($instanceKey)) {
200 // This might happen if a non-registered key was requested
201 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
205 $objectInstance = $this->getGenericArrayKey('registry', 'instance', $instanceKey);
208 return $objectInstance;
212 * "Getter" for a registry key for given prefix and array. This method
213 * calls implode() to get a suitable key. This method does not care about
216 * @param $prefix Prefix for the key
217 * @param $data An array with data
218 * @return $registryKey A registry key
220 public static function getRegistryKeyFromArray ($prefix, array $data) {
221 // "Generate" the key
222 $registryKey = $prefix . self::REGISTRY_KEY_GLUE . implode(self::REGISTRY_KEY_GLUE, $data);