application/hub/main/factories/source/units/class_UnitSourceFactory.php

   1 <?php
   2 /**
   3  * A factory class for unit sources
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.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 UnitSourceFactory 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          * Creates an instance of a configurable and singleton unit source
  37          *
  38          * @param       $unitType                       Type of the unit source
  39          * @return      $sourceInstance         A UnitSource class instance
  40          */
  41         public static final function createUnitSourceInstance ($unitType) {
  42                 // Do we have cache?
  43                 if (!Registry::getRegistry()->instanceExists($unitType . '_unit_source')) {
  44                         // Then construct the class' configuraton entry
  45                         $className = '' . $unitType . '_unit_source_class';
  46
  47                         // Get a class from that configuration entry
  48                         $sourceInstance = self::createObjectByConfiguredName($className);
  49
  50                         // Add it to the registry
  51                         Registry::getRegistry()->addInstance($unitType . '_unit_source', $sourceInstance);
  52                 } else {
  53                         // Get it from registry
  54                         $sourceInstance = Registry::getRegistry()->getInstance($unitType . '_unit_source');
  55                 }
  56
  57                 // For any purposes, return the source instance
  58                 return $sourceInstance;
  59         }
  60 }
  61
  62 // [EOF]
  63 ?>