3 namespace Org\Mxchange\CoreFramework\Registry;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
7 use Org\Mxchange\CoreFramework\Generic\NullPointerException;
8 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
11 use \IteratorAggregate;
16 * @author Roland Haeder <webmaster@shipsimu.org>
18 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
19 * @license GNU GPL 3.0 or any newer version
20 * @link http://www.shipsimu.org
22 * This program is free software: you can redistribute it and/or modify
23 * it under the terms of the GNU General Public License as published by
24 * the Free Software Foundation, either version 3 of the License, or
25 * (at your option) any later version.
27 * This program is distributed in the hope that it will be useful,
28 * but WITHOUT ANY WARRANTY; without even the implied warranty of
29 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30 * GNU General Public License for more details.
32 * You should have received a copy of the GNU General Public License
33 * along with this program. If not, see <http://www.gnu.org/licenses/>.
35 abstract class BaseRegistry extends BaseFrameworkSystem implements Register, Registerable, IteratorAggregate {
37 * Glue for generating a registry key
39 const REGISTRY_KEY_GLUE = '_';
42 * Instance of this class
44 private static $registryInstance = NULL;
47 * Protected constructor
49 * @param $className Name of the class
52 protected function __construct ($className) {
53 // Call parent constructor
54 parent::__construct($className);
56 // Init generic arrays
57 $this->initGenericArrayGroup('registry', 'generic');
58 $this->initGenericArrayGroup('registry', 'instance');
62 * Returns an iterator for this whole registry.
64 * @return $iteratorInstance An instance of a Iterator class
66 public function getIterator () {
68 if (is_null($this->getIteratorInstance())) {
70 $iteratorInstance = ObjectFactory::createObjectByConfiguredName('registry_iterator_class', array($this));
72 // ... and set it here
73 $this->setIteratorInstance($iteratorInstance);
76 $iteratorInstance = $this->getIteratorInstance();
80 return $iteratorInstance;
84 * Checks whether an instance key was found
86 * @param $instanceKey The key holding an instance in registry
87 * @return $exists Whether the key exists in registry
89 public function instanceExists ($instanceKey) {
90 // Does this key exists?
91 $exists = $this->isGenericArrayKeySet('registry', 'instance', $instanceKey);
98 * Adds/overwrites a new instance to the registry at the given key
100 * @param $instanceKey The key to identify the instance
101 * @param $objectInstance An instance we shall store
104 public function addInstance ($instanceKey, Registerable $objectInstance) {
105 $this->setGenericArrayKey('registry', 'instance', $instanceKey, $objectInstance);
109 * Getter for whole generic registry
111 * @return $instanceRegistry The whole generic registry array
113 public final function getGenericRegistry () {
114 return $this->getGenericSubArray('registry', 'generic');
118 * Getter for whole instance registry
120 * @return $instanceRegistry The whole instance registry array
122 public final function getInstanceRegistry () {
123 return $this->getGenericSubArray('registry', 'instance');
127 * Adds a new entry to the given list name. If you want to add objects
128 * please use addInstance() and getInstance() instead.
130 * @param $key The key to identify the whole list
131 * @param $value The value to be stored
134 public final function addEntry ($key, $value) {
135 // Key must not be an array
136 assert(!is_array($key));
139 $this->pushValueToGenericArrayKey('registry', 'generic', $key, $value);
143 * Getter for entries or "sub entries"
145 * @return $entries An array with entries from this registry
147 public final function getEntries ($key = NULL) {
148 // Key must not be an array
149 assert(!is_array($key));
151 // Default is whole array
152 $entries = $this->getGenericArray('registry');
155 if (!is_null($key)) {
156 // Then use this entry
157 $entries = $this->getGenericArrayKey('registry', 'generic', $key);
165 * "Getter" for an array of all entries for given key
167 * @param $arrayKey The array (key) to look in
168 * @param $lookFor The key to look for
169 * @return $entry An array with all keys
171 public function getArrayFromKey ($arrayKey, $lookFor) {
172 // Key must not be an array
173 assert(!is_array($arrayKey));
179 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('REGISTRY[' . __METHOD__ . ':' . __LINE__ . ']: Checking arrayKey=' . $arrayKey . ',lookFor=' . $lookFor);
181 // "Walk" over all entries
182 foreach ($this->getEntries($arrayKey) as $key => $value) {
184 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('REGISTRY[' . __METHOD__ . ':' . __LINE__ . ']: Checking key=' . $key . ',value=' . $value . ',lookFor=' . $lookFor);
186 // If $value matches the $lookFor, we need to look for more entries for this!
187 if ($lookFor == $value) {
188 // Look for more entries
189 foreach ($this->getEntries() as $key2 => $value2) {
190 // Now "walk" through all entries, if an array is returned
191 if (is_array($value2)) {
193 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('REGISTRY[' . __METHOD__ . ':' . __LINE__ . ']: Checking key2=' . $key2 . ',value2()=' . count($value2) . ',lookFor=' . $lookFor);
195 // "Walk" through all of them
196 foreach ($value2 as $key3 => $value3) {
197 // $value3 needs to be an array
198 assert(is_array($value3));
201 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('REGISTRY[' . __METHOD__ . ':' . __LINE__ . ']: Checking key=' . $key . ',key3=' . $key3 . ',isset()=' . isset($value3[$key]) . ' ...');
203 // Both keys must match!
204 if (($key == $key3) || (isset($value3[$key]))) {
206 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('REGISTRY[' . __METHOD__ . ':' . __LINE__ . ']: Adding ' . $value3[$key] . ' ...');
209 $entry[$key3] = $value3[$key];
215 // Skip further lookups
221 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('REGISTRY[' . __METHOD__ . ':' . __LINE__ . ']: Returning entry(' . count($entry) . ')=' . print_r($entry, true));
228 * Gets a registered instance or null if not found
230 * @param $instanceKey The key to identify the instance
231 * @return $objectInstance An instance we shall store
232 * @throws NullPointerException If the requested key is not found
234 public function getInstance ($instanceKey) {
235 // Is the instance there?
236 if (!$this->instanceExists($instanceKey)) {
237 // This might happen if a non-registered key was requested
238 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
242 $objectInstance = $this->getGenericArrayKey('registry', 'instance', $instanceKey);
245 return $objectInstance;
249 * "Getter" for a registry key for given prefix and array. This method
250 * calls implode() to get a suitable key. This method does not care about
253 * @param $prefix Prefix for the key
254 * @param $data An array with data
255 * @return $registryKey A registry key
257 public static function getRegistryKeyFromArray ($prefix, array $data) {
258 // "Generate" the key
259 $registryKey = $prefix . self::REGISTRY_KEY_GLUE . implode(self::REGISTRY_KEY_GLUE, $data);