framework/main/classes/registry/format_upgrade/database/class_LocalFileDatabaseFormatUpgradeRegistry.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Registry\Upgrade\Format\Lfdb;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Registry\BaseRegistry;
   7 use Org\Mxchange\CoreFramework\Upgrade\Format\Database\UpgradeableDatabaseFormat;
   8 use Org\Mxchange\CoreFramework\Upgrade\Format\RegisterableFormatUpgrade;
   9
  10 /**
  11  * A LocalFileDatabase database-format-upgrade registry
  12  *
  13  * @author              Roland Haeder <webmaster@ship-simu.org>
  14  * @version             0.0.0
  15  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2019 Core Developer Team
  16  * @license             GNU GPL 3.0 or any newer version
  17  * @link                http://www.ship-simu.org
  18  *
  19  * This program is free software: you can redistribute it and/or modify
  20  * it under the terms of the GNU General Public License as published by
  21  * the Free Software Foundation, either version 3 of the License, or
  22  * (at your option) any later version.
  23  *
  24  * This program is distributed in the hope that it will be useful,
  25  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  * GNU General Public License for more details.
  28  *
  29  * You should have received a copy of the GNU General Public License
  30  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  31  */
  32 class LocalFileDatabaseFormatUpgradeRegistry extends BaseRegistry implements RegisterableFormatUpgrade {
  33         /**
  34          * Instance of this class
  35          */
  36         private static $registryInstance = null;
  37
  38         /**
  39          * Protected constructor
  40          *
  41          * @return      void
  42          */
  43         protected function __construct () {
  44                 // Call parent constructor
  45                 parent::__construct(__CLASS__);
  46         }
  47
  48         /**
  49          * Singleton getter for self instance. This class has no factory pattern
  50          * because here is no need for special parameters.
  51          *
  52          * @return      $registryInstance       Instance of this class
  53          */
  54         public final static function getRegistry () {
  55                 // Is an instance there?
  56                 if (is_null(self::$registryInstance)) {
  57                         // Not yet, so create one
  58                         self::$registryInstance = new LocalFileDatabaseFormatUpgradeRegistry();
  59                 } // END - if
  60
  61                 // Return the instance
  62                 return self::$registryInstance;
  63         }
  64
  65         /**
  66          * Registers given format-upgrade class with this registry
  67          *
  68          * @param       $upgradeInstance        An instance of a UpgradeableDatabaseFormat class
  69          * @return      void
  70          * @todo        0% done
  71          */
  72         public function registerFormatUpgrader (UpgradeableDatabaseFormat $upgradeInstance) {
  73                 $this->partialStub();
  74         }
  75
  76 }