a4b25b99f14e312ee31b32c14fe990755a0c6790
[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 - 2012 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          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33         }
34
35         /**
36          * Returns a singleton socket registry instance. If an instance is found in
37          * the registry it will be returned, else a new instance is created and
38          * stored in the same registry entry.
39          *
40          * @return      $registryInstance       A socket registry instance
41          */
42         public static final function createSocketRegistryInstance () {
43                 // Get registry instance
44                 $registryInstance = Registry::getRegistry();
45
46                 // Do we have an instance in the registry?
47                 if ($registryInstance->instanceExists('socket_registry')) {
48                         // Then use this instance
49                         $registryInstance = $registryInstance->getInstance('socket_registry');
50                 } else {
51                         // Get the registry instance
52                         $registryInstance = ObjectFactory::createObjectByConfiguredName('socket_registry_class');
53
54                         // Set the instance in registry for further use
55                         $registryInstance->addInstance('socket_registry', $registryInstance);
56                 }
57
58                 // Return the instance
59                 return $registryInstance;
60         }
61 }
62
63 // [EOF]
64 ?>