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 * @param $onlyRegistries Only iterate on these sub-registry keys, default is all
65 * @return $iteratorInstance An instance of a Iterator class
67 public function getIterator (array $onlyRegistries = []) {
69 if (is_null($this->getIteratorInstance())) {
71 $iteratorInstance = ObjectFactory::createObjectByConfiguredName('registry_iterator_class', array($this));
73 // ... and set it here
74 $this->setIteratorInstance($iteratorInstance);
77 $iteratorInstance = $this->getIteratorInstance();
80 // Init iterator instance
81 $iteratorInstance->initIterator($onlyRegistries);
84 return $iteratorInstance;
88 * Checks whether an instance key was found
90 * @param $instanceKey The key holding an instance in registry
91 * @return $exists Whether the key exists in registry
93 public function instanceExists ($instanceKey) {
94 // Does this key exists?
95 $exists = $this->isGenericArrayKeySet('registry', 'instance', $instanceKey);
102 * Adds/overwrites a new instance to the registry at the given key
104 * @param $instanceKey The key to identify the instance
105 * @param $objectInstance An instance we shall store
108 public function addInstance ($instanceKey, Registerable $objectInstance) {
109 $this->setGenericArrayKey('registry', 'instance', $instanceKey, $objectInstance);
113 * Getter for whole generic registry
115 * @return $instanceRegistry The whole generic registry array
117 public final function getGenericRegistry () {
118 return $this->getGenericSubArray('registry', 'generic');
122 * Getter for whole instance registry
124 * @return $instanceRegistry The whole instance registry array
126 public final function getInstanceRegistry () {
127 return $this->getGenericSubArray('registry', 'instance');
131 * Adds a new entry to the given list name. If you want to add objects
132 * please use addInstance() and getInstance() instead.
134 * @param $key The key to identify the whole list
135 * @param $value The value to be stored
138 public final function addEntry ($key, $value) {
139 // Key must not be an array
140 assert(!is_array($key));
143 $this->pushValueToGenericArrayKey('registry', 'generic', $key, $value);
147 * Getter for entries or "sub entries"
149 * @return $entries An array with entries from this registry
151 public final function getEntries ($key = NULL) {
152 // Key must not be an array
153 assert(!is_array($key));
155 // Default is whole array
156 $entries = $this->getGenericArray('registry');
159 if (!is_null($key)) {
160 // Then use this entry
161 $entries = $this->getGenericArrayKey('registry', 'generic', $key);
169 * "Getter" for an array of all entries for given key
171 * @param $arrayKey The array (key) to look in
172 * @param $lookFor The key to look for
173 * @return $entry An array with all keys
175 public function getArrayFromKey ($arrayKey, $lookFor) {
176 // Key must not be an array
177 assert(!is_array($arrayKey));
183 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('REGISTRY: Checking arrayKey=' . $arrayKey . ',lookFor=' . $lookFor);
185 // "Walk" over all entries
186 foreach ($this->getEntries($arrayKey) as $key => $value) {
188 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('REGISTRY: Checking key=' . $key . ',value=' . $value . ',lookFor=' . $lookFor);
190 // If $value matches the $lookFor, we need to look for more entries for this!
191 if ($lookFor == $value) {
192 // Look for more entries
193 foreach ($this->getEntries() as $key2 => $value2) {
194 // Now "walk" through all entries, if an array is returned
195 if (is_array($value2)) {
197 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('REGISTRY: Checking key2=' . $key2 . ',value2()=' . count($value2) . ',lookFor=' . $lookFor);
199 // "Walk" through all of them
200 foreach ($value2 as $key3 => $value3) {
201 // $value3 needs to be an array
202 assert(is_array($value3));
205 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('REGISTRY: Checking key=' . $key . ',key3=' . $key3 . ',isset()=' . isset($value3[$key]) . ' ...');
207 // Both keys must match!
208 if (($key == $key3) || (isset($value3[$key]))) {
210 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('REGISTRY: Adding ' . $value3[$key] . ' ...');
213 $entry[$key3] = $value3[$key];
219 // Skip further lookups
225 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('REGISTRY: Returning entry(' . count($entry) . ')=' . print_r($entry, true));
232 * Gets a registered instance or null if not found
234 * @param $instanceKey The key to identify the instance
235 * @return $objectInstance An instance we shall store
236 * @throws NullPointerException If the requested key is not found
238 public function getInstance ($instanceKey) {
239 // Is the instance there?
240 if (!$this->instanceExists($instanceKey)) {
241 // This might happen if a non-registered key was requested
242 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
246 $objectInstance = $this->getGenericArrayKey('registry', 'instance', $instanceKey);
249 return $objectInstance;
253 * "Getter" for a registry key for given prefix and array. This method
254 * calls implode() to get a suitable key. This method does not care about
257 * @param $prefix Prefix for the key
258 * @param $data An array with data
259 * @return $registryKey A registry key
261 public static function getRegistryKeyFromArray ($prefix, array $data) {
262 // "Generate" the key
263 $registryKey = $prefix . self::REGISTRY_KEY_GLUE . implode(self::REGISTRY_KEY_GLUE, $data);