Renamed Registry -> GenericRegistry to make it clear that this registry does
[core.git] / framework / main / classes / factories / database / class_DatabaseWrapperFactory.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Factory\Database\Wrapper;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
7 use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
8
9 /**
10  * A factory class for socket registries
11  *
12  * @author              Roland Haeder <webmaster@shipsimu.org>
13  * @version             0.0.0
14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
15  * @license             GNU GPL 3.0 or any newer version
16  * @link                http://www.shipsimu.org
17  *
18  * This program is free software: you can redistribute it and/or modify
19  * it under the terms of the GNU General Public License as published by
20  * the Free Software Foundation, either version 3 of the License, or
21  * (at your option) any later version.
22  *
23  * This program is distributed in the hope that it will be useful,
24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
26  * GNU General Public License for more details.
27  *
28  * You should have received a copy of the GNU General Public License
29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
30  */
31 class DatabaseWrapperFactory extends ObjectFactory {
32         /**
33          * Protected constructor
34          *
35          * @return      void
36          */
37         protected function __construct () {
38                 // Call parent constructor
39                 parent::__construct(__CLASS__);
40         }
41
42         /**
43          * Returns a singleton socket registry instance. If an instance is found in
44          * the registry it will be returned, else a new instance is created and
45          * stored in the same registry entry.
46          *
47          * @return      $wrapperInstance        A database wrapper instance
48          */
49         public static final function createWrapperByConfiguredName ($wrapperName) {
50                 // Get registry instance
51                 $registryInstance = GenericRegistry::getRegistry();
52
53                 // Do we have an instance in the registry?
54                 if ($registryInstance->instanceExists($wrapperName)) {
55                         // Then use this instance
56                         $wrapperInstance = $registryInstance->getInstance($wrapperName);
57                 } else {
58                         // Get the registry instance
59                         $wrapperInstance = self::createObjectByConfiguredName($wrapperName);
60
61                         // Set the instance in registry for further use
62                         $registryInstance->addInstance($wrapperName, $wrapperInstance);
63                 }
64
65                 // Return the instance
66                 return $wrapperInstance;
67         }
68
69 }