inc/main/classes/factories/stacks/class_FileStackFactory.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Factory\Stack;
   4
   5 // Import framework stuff
   6 use CoreFramework\Configuration\FrameworkConfiguration;
   7
   8 /**
   9  * A factory class for file-based stacks
  10  *
  11  * @author              Roland Haeder <webmaster@ship-simu.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.ship-simu.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 FileStackFactory 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 (registry-based) StackableFile instance
  43          *
  44          * @param       $prefix                         Class prefix
  45          * @param       $stackName                      Name of the stack
  46          * @return      $stackInstance          An instance of a StackableFile class
  47          */
  48         public static final function createFileStackInstance ($prefix, $stackName) {
  49                 // Construct file stack name
  50                 $stackFileName = sprintf('%s%s/%s.%s',
  51                         FrameworkConfiguration::getSelfInstance()->getConfigEntry('base_path'),
  52                         FrameworkConfiguration::getSelfInstance()->getConfigEntry('base_file_stacks_path'),
  53                         $stackName,
  54                         FrameworkConfiguration::getSelfInstance()->getConfigEntry('file_stacks_extension')
  55                 );
  56
  57                 // If there is no handler?
  58                 if (Registry::getRegistry()->instanceExists($stackName . '_stack')) {
  59                         // Get handler from registry
  60                         $stackInstance = Registry::getRegistry()->getInstance($stackName . '_stack');
  61                 } else {
  62                         // Get the handler instance
  63                         $stackInstance = self::createObjectByConfiguredName($prefix . '_' . $stackName . '_stack_class', array($stackFileName, $prefix . '_' . $stackName));
  64
  65                         // Add it to the registry
  66                         Registry::getRegistry()->addInstance($stackName . '_stack', $stackInstance);
  67                 }
  68
  69                 // Return the instance
  70                 return $stackInstance;
  71         }
  72 }
  73
  74 // [EOF]
  75 ?>