280cae367dbf57eae1d1179f7272a34351208627
[core.git] / inc / classes / main / factories / registry / class_SocketRegistryFactory.php
1 <?php
2 /**
3  * A factory class for socket registries
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
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 SocketRegistryFactory extends ObjectFactory {
25         /**
26          * Returns a singleton socket registry instance. If an instance is found in
27          * the registry it will be returned, else a new instance is created and
28          * stored in the same registry entry.
29          *
30          * @return      $packageInstance        A socket registry instance
31          */
32         public static final function createSocketRegistryInstance () {
33                 // Get registry instance
34                 $registryInstance = Registry::getRegistry();
35
36                 // Do we have an instance in the registry?
37                 if ($registryInstance->instanceExists('socket_registry')) {
38                         // Then use this instance
39                         $packageInstance = $registryInstance->getInstance('socket_registry');
40                 } else {
41                         // Get the registry instance
42                         $packageInstance = ObjectFactory::createObjectByConfiguredName('socket_registry_class');
43
44                         // Set the instance in registry for further use
45                         $registryInstance->addInstance('socket_registry', $packageInstance);
46                 }
47
48                 // Return the instance
49                 return $packageInstance;
50         }
51
52         /**
53          * Protected constructor
54          *
55          * @return      void
56          */
57         protected function __construct () {
58                 // Call parent constructor
59                 parent::__construct(__CLASS__);
60         }
61 }
62
63 // [EOF]
64 ?>