A much better name is HandleableProtocol.
[core.git] / inc / classes / interfaces / registry / class_Register.php
1 <?php
2 /**
3  * An interface for registries
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.org
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
23  */
24 interface Register extends FrameworkInterface {
25         /**
26          * Checks whether an instance key was found
27          *
28          * @param       $instanceKey    The key holding an instance in registry
29          * @return      $exists                 Whether the key exists in registry
30          */
31         function instanceExists ($instanceKey);
32
33         /**
34          * Adds/overwrites a new instance to the registry at the given key
35          *
36          * @param       $instanceKey            The key to identify the instance
37          * @param       $objectInstance         An instance we shall store
38          * @return      void
39          */
40         function addInstance ($instanceKey, Registerable $objectInstance);
41
42         /**
43          * Gets a registered instance or null if not found
44          *
45          * @param       $instanceKey            The key to identify the instance
46          * @return      $objectInstance         An instance we shall store
47          */
48         function getInstance ($instanceKey);
49 }
50
51 // [EOF]
52 ?>