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

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Factory\Stack;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
   7 use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
   8 use Org\Mxchange\CoreFramework\Registry\Registry;
   9
  10 // Import SPL stuff
  11 use \SplFileInfo;
  12
  13 /**
  14  * A factory class for file-based stacks
  15  *
  16  * @author              Roland Haeder <webmaster@ship-simu.org>
  17  * @version             0.0.0
  18 <<<<<<< HEAD:framework/main/classes/factories/stacks/class_FileStackFactory.php
  19  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  20 =======
  21  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
  22 >>>>>>> Some updates::inc/main/classes/factories/stacks/class_FileStackFactory.php
  23  * @license             GNU GPL 3.0 or any newer version
  24  * @link                http://www.ship-simu.org
  25  *
  26  * This program is free software: you can redistribute it and/or modify
  27  * it under the terms of the GNU General Public License as published by
  28  * the Free Software Foundation, either version 3 of the License, or
  29  * (at your option) any later version.
  30  *
  31  * This program is distributed in the hope that it will be useful,
  32  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  33  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  34  * GNU General Public License for more details.
  35  *
  36  * You should have received a copy of the GNU General Public License
  37  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  38  */
  39 class FileStackFactory extends ObjectFactory {
  40         /**
  41          * Protected constructor
  42          *
  43          * @return      void
  44          */
  45         protected function __construct () {
  46                 // Call parent constructor
  47                 parent::__construct(__CLASS__);
  48         }
  49
  50         /**
  51          * Returns a singleton (registry-based) StackableFile instance
  52          *
  53          * @param       $prefix                         Class prefix
  54          * @param       $stackName                      Name of the stack
  55          * @return      $stackInstance          An instance of a StackableFile class
  56          */
  57         public static final function createFileStackInstance ($prefix, $stackName) {
  58                 // Construct file stack name
  59                 $fileInfoInstance = new SplFileInfo(sprintf('%s%s/%s.%s',
  60                         FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('root_base_path'),
  61                         FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('base_file_stacks_path'),
  62                         $stackName,
  63                         FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('file_stacks_extension')
  64                 ));
  65
  66                 // If there is no handler?
  67                 if (Registry::getRegistry()->instanceExists($stackName . '_stack')) {
  68                         // Get handler from registry
  69                         $stackInstance = Registry::getRegistry()->getInstance($stackName . '_stack');
  70                 } else {
  71                         // Get the handler instance
  72                         $stackInstance = self::createObjectByConfiguredName($prefix . '_' . $stackName . '_stack_class', array($fileInfoInstance, $prefix . '_' . $stackName));
  73
  74                         // Add it to the registry
  75                         Registry::getRegistry()->addInstance($stackName . '_stack', $stackInstance);
  76                 }
  77
  78                 // Return the instance
  79                 return $stackInstance;
  80         }
  81
  82 }