Launcher scripts updated
[mailer.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, 2008 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 $selfInstance = 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
56          *
57          * @return      $selfInstance   Instance of this class
58          */
59         public final static function getRegistry () {
60                 // Is an instance there?
61                 if (is_null(self::$selfInstance)) {
62                         // Not yet, so create one
63                         self::$selfInstance = new Registry();
64                 }
65
66                 // Return the instance
67                 return self::$selfInstance;
68         }
69
70         /**
71          * Checks or sets wether the registry has been initialized. This had only be done once
72          *
73          * @param       $initialized    Wether the registry is initialized
74          * @return      $initialized    Wether the registry is initialized
75          */
76         public final static function isInitialized ($initialized = null) {
77                 if (is_null($initialized)) {
78                         // Get status if initialized
79                         return self::$initialized;
80                 } elseif (!is_null($initialized)) {
81                         // Registry is initialized!
82                         self::$initialized = true;
83                 }
84         }
85
86         /**
87          * Checks wether an instance key was found
88          *
89          * @param       $instanceKey    The key holding an instance in registry
90          * @return      $exists                 Wether the key exists in registry
91          */
92         public function instanceExists ($instanceKey) {
93                 // Does this key exists?
94                 $exists = (isset($this->instanceRegistry[$instanceKey]));
95
96                 // Return the result
97                 return $exists;
98         }
99
100         /**
101          * Adds/overwrites a new instance to the registry at the given key
102          *
103          * @param       $instanceKey            The key to identify the instance
104          * @param       $objectInstance         An instance we shall store
105          * @return      void
106          */
107         public function addInstance ($instanceKey, Registerable $objectInstance) {
108                 $this->instanceRegistry[$instanceKey] = $objectInstance;
109         }
110
111         /**
112          * Gets a registered instance or null if not found
113          *
114          * @param       $instanceKey            The key to identify the instance
115          * @return      $objectInstance         An instance we shall store
116          */
117         public function getInstance ($instanceKey) {
118                 // By default the instance is not in registry
119                 $objectInstance = null;
120
121                 // Is the instance there?
122                 if ($this->instanceExists($instanceKey)) {
123                         $objectInstance = $this->instanceRegistry[$instanceKey];
124                 }
125
126                 // Return the result
127                 return $objectInstance;
128         }
129 }
130
131 // [EOF]
132 ?>