3 namespace Org\Mxchange\CoreFramework\Registry;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
9 * An interface for registries
11 * @author Roland Haeder <webmaster@shipsimu.org>
13 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 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 interface Register extends FrameworkInterface {
32 * Checks whether an instance key was found
34 * @param $instanceKey The key holding an instance in registry
35 * @return $exists Whether the key exists in registry
37 function instanceExists ($instanceKey);
40 * Adds/overwrites a new instance to the registry at the given key
42 * @param $instanceKey The key to identify the instance
43 * @param $objectInstance An instance we shall store
46 function addInstance ($instanceKey, Registerable $objectInstance);
49 * Getter for whole generic registry
51 * @return $instanceRegistry The whole generic registry array
53 function getGenericRegistry ();
56 * Getter for whole instance registry
58 * @return $instanceRegistry The whole instance registry array
60 function getInstanceRegistry ();
63 * Adds a new entry to the given list name. If you want to add objects
64 * please use addInstance() and getInstance() instead.
66 * @param $key The key to identify the whole list
67 * @param $value The value to be stored
70 function addEntry ($key, $value);
73 * Getter for entries or "sub entries"
75 * @return $entries An array with entries from this registry
77 function getEntries ($key = NULL);
80 * "Getter" for an array of all entries for given key
82 * @param $arrayKey The array (key) to look in
83 * @param $lookFor The key to look for
84 * @return $entry An array with all keys
86 function getArrayFromKey ($arrayKey, $lookFor);
89 * Gets a registered instance or null if not found
91 * @param $instanceKey The key to identify the instance
92 * @return $objectInstance An instance we shall store
93 * @throws NullPointerException If the requested key is not found
95 function getInstance ($instanceKey);