inc/main/classes/factories/database/class_DatabaseWrapperFactory.php

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