3 namespace CoreFramework\Registry;
5 // Import framework stuff
6 use CoreFramework\Generic\NullPointerException;
7 use CoreFramework\Object\BaseFrameworkSystem;
12 * @author Roland Haeder <webmaster@shipsimu.org>
14 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
15 * @license GNU GPL 3.0 or any newer version
16 * @link http://www.shipsimu.org
18 * This program is free software: you can redistribute it and/or modify
19 * it under the terms of the GNU General Public License as published by
20 * the Free Software Foundation, either version 3 of the License, or
21 * (at your option) any later version.
23 * This program is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
28 * You should have received a copy of the GNU General Public License
29 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 class BaseRegistry extends BaseFrameworkSystem implements Registerable {
33 * Glue for generating a registry key
35 const REGISTRY_KEY_GLUE = '_';
38 * Instance of this class
40 private static $registryInstance = NULL;
43 * Protected constructor
45 * @param $className Name of the class
48 protected function __construct ($className) {
49 // Call parent constructor
50 parent::__construct($className);
53 $this->initGenericArrayGroup('raw', 'generic');
57 * Checks whether an instance key was found
59 * @param $instanceKey The key holding an instance in registry
60 * @return $exists Whether the key exists in registry
62 public function instanceExists ($instanceKey) {
63 // Does this key exists?
64 $exists = $this->isGenericArrayKeySet('registry', 'instance', $instanceKey);
71 * Adds/overwrites a new instance to the registry at the given key
73 * @param $instanceKey The key to identify the instance
74 * @param $objectInstance An instance we shall store
77 public function addInstance ($instanceKey, Registerable $objectInstance) {
78 $this->setGenericArrayKey('registry', 'instance', $instanceKey, $objectInstance);
82 * Getter for whole instance registry
84 * @return $instanceRegistry The whole instance registry array
86 public final function getInstanceRegistry () {
87 return $this->getGenericSubArray('registry', 'instance');
91 * Adds a new entry to the given list name. If you want to add objects
92 * please use addInstance() and getInstance() instead.
94 * @param $key The key to identify the whole list
95 * @param $value The value to be stored
98 public final function addEntry ($key, $value) {
99 // Key must not be an array
100 assert(!is_array($key));
103 $this->pushValueToGenericArrayKey('raw', 'generic', $key, $value);
107 * Getter for entries or "sub entries"
109 * @return $entries An array with entries from this registry
111 public final function getEntries ($key = NULL) {
112 // Key must not be an array
113 assert(!is_array($key));
115 // Default is whole array
116 $entries = $this->getGenericArray('raw');
119 if (!is_null($key)) {
120 // Then use this entry
121 $entries = $this->getGenericArrayKey('raw', 'generic', $key);
129 * "Getter" for an array of all entries for given key
131 * @param $arrayKey The array (key) to look in
132 * @param $lookFor The key to look for
133 * @return $entry An array with all keys
135 public function getArrayFromKey ($arrayKey, $lookFor) {
136 // Key must not be an array
137 assert(!is_array($arrayKey));
143 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('REGISTRY[' . __METHOD__ . ':' . __LINE__ . ']: Checking arrayKey=' . $arrayKey . ',lookFor=' . $lookFor);
145 // "Walk" over all entries
146 foreach ($this->getEntries($arrayKey) as $key => $value) {
148 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('REGISTRY[' . __METHOD__ . ':' . __LINE__ . ']: Checking key=' . $key . ',value=' . $value . ',lookFor=' . $lookFor);
150 // If $value matches the $lookFor, we need to look for more entries for this!
151 if ($lookFor == $value) {
152 // Look for more entries
153 foreach ($this->getEntries() as $key2 => $value2) {
154 // Now "walk" through all entries, if an array is returned
155 if (is_array($value2)) {
157 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('REGISTRY[' . __METHOD__ . ':' . __LINE__ . ']: Checking key2=' . $key2 . ',value2()=' . count($value2) . ',lookFor=' . $lookFor);
159 // "Walk" through all of them
160 foreach ($value2 as $key3 => $value3) {
161 // $value3 needs to be an array
162 assert(is_array($value3));
165 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('REGISTRY[' . __METHOD__ . ':' . __LINE__ . ']: Checking key=' . $key . ',key3=' . $key3 . ',isset()=' . isset($value3[$key]) . ' ...');
167 // Both keys must match!
168 if (($key == $key3) || (isset($value3[$key]))) {
170 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('REGISTRY[' . __METHOD__ . ':' . __LINE__ . ']: Adding ' . $value3[$key] . ' ...');
173 $entry[$key3] = $value3[$key];
179 // Skip further lookups
185 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('REGISTRY[' . __METHOD__ . ':' . __LINE__ . ']: Returning entry(' . count($entry) . ')=' . print_r($entry, TRUE));
192 * Gets a registered instance or null if not found
194 * @param $instanceKey The key to identify the instance
195 * @return $objectInstance An instance we shall store
196 * @throws NullPointerException If the requested key is not found
198 public function getInstance ($instanceKey) {
199 // Is the instance there?
200 if (!$this->instanceExists($instanceKey)) {
201 // This might happen if a non-registered key was requested
202 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
206 $objectInstance = $this->getGenericArrayKey('registry', 'instance', $instanceKey);
209 return $objectInstance;
213 * "Getter" for a registry key for given prefix and array. This method
214 * calls implode() to get a suitable key. This method does not care about
217 * @param $prefix Prefix for the key
218 * @param $data An array with data
219 * @return $registryKey A registry key
221 public static function getRegistryKeyFromArray ($prefix, array $data) {
222 // "Generate" the key
223 $registryKey = $prefix . self::REGISTRY_KEY_GLUE . implode(self::REGISTRY_KEY_GLUE, $data);