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