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