243c2b49f5ad44488ee5792dae58a143371d54b3
[core.git] / inc / classes / main / registry / class_Registry.php
1 <?php
2 /**
3  * A registry for several data types
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007 - 2009 Roland Haeder, this is free software
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.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 class Registry extends BaseFrameworkSystem implements Register {
25         /**
26          * Instance of this class
27          */
28         private static $registryInstance = null;
29
30         /**
31          * Wether the registry is initialized
32          */
33         private static $initialized = false;
34
35         /**
36          * Instance registry
37          */
38         private $instanceRegistry = array();
39
40         /**
41          * Protected constructor
42          *
43          * @return      void
44          */
45         protected function __construct () {
46                 // Call parent constructor
47                 parent::__construct(__CLASS__);
48
49                 // Clean up a little
50                 $this->removeNumberFormaters();
51                 $this->removeSystemArray();
52         }
53
54         /**
55          * Singleton getter for self instance. This class has no factory pattern
56          * because here is no need for special parameters.
57          *
58          * @return      $registryInstance       Instance of this class
59          */
60         public final static function getRegistry () {
61                 // Is an instance there?
62                 if (is_null(self::$registryInstance)) {
63                         // Not yet, so create one
64                         self::$registryInstance = new Registry();
65                 }
66
67                 // Return the instance
68                 return self::$registryInstance;
69         }
70
71         /**
72          * Checks or sets wether the registry has been initialized. This had only
73          * be done once.
74          *
75          * @param       $initialized    Wether the registry is initialized
76          * @return      $initialized    Wether the registry is initialized
77          */
78         public final static function isInitialized ($initialized = null) {
79                 // If no parameter (null by default) is provided we want to get the
80                 // parameter. If set to e.g. "OK" then the registry is set to
81                 // "initialized".
82                 if (is_null($initialized)) {
83                         // Get status if initialized
84                         return self::$initialized;
85                 } else {
86                         // Registry is initialized!
87                         self::$initialized = true;
88                 }
89         }
90
91         /**
92          * Checks wether an instance key was found
93          *
94          * @param       $instanceKey    The key holding an instance in registry
95          * @return      $exists                 Wether the key exists in registry
96          */
97         public function instanceExists ($instanceKey) {
98                 // Does this key exists?
99                 $exists = (isset($this->instanceRegistry[$instanceKey]));
100
101                 // Return the result
102                 return $exists;
103         }
104
105         /**
106          * Adds/overwrites a new instance to the registry at the given key
107          *
108          * @param       $instanceKey            The key to identify the instance
109          * @param       $objectInstance         An instance we shall store
110          * @return      void
111          */
112         public function addInstance ($instanceKey, Registerable $objectInstance) {
113                 $this->instanceRegistry[$instanceKey] = $objectInstance;
114         }
115
116         /**
117          * Gets a registered instance or null if not found
118          *
119          * @param       $instanceKey            The key to identify the instance
120          * @return      $objectInstance         An instance we shall store
121          */
122         public function getInstance ($instanceKey) {
123                 // By default the instance is not in registry
124                 $objectInstance = null;
125
126                 // Is the instance there?
127                 if ($this->instanceExists($instanceKey)) {
128                         $objectInstance = $this->instanceRegistry[$instanceKey];
129                 }
130
131                 // Return the result
132                 return $objectInstance;
133         }
134 }
135
136 // [EOF]
137 ?>