framework/main/classes/factories/index/class_FileStackIndexFactory.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Factory\Filesystem\Stack;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
   7 use Org\Mxchange\CoreFramework\Registry\Registry;
   8 use Org\Mxchange\CoreFramework\Stacker\Index\IndexableStack;
   9
  10 // Import SPL stuff
  11 use \SplFileInfo;
  12
  13 /**
  14  * A factory class for file-based stack indexes
  15  *
  16  * @author              Roland Haeder <webmaster@ship-simu.org>
  17  * @version             0.0.0
  18 <<<<<<< HEAD:framework/main/classes/factories/index/class_FileStackIndexFactory.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/index/class_FileStackIndexFactory.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 FileStackIndexFactory 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       $infoInstance   An instance of a SplFileInfo class
  54          * @return      $indexInstance  An instance of a IndexableStack class
  55          */
  56         public static final function createFileStackIndexInstance (SplFileInfo $infoInstance, $type) {
  57                 // If there is no handler?
  58                 if (Registry::getRegistry()->instanceExists($type . '_index')) {
  59                         // Get handler from registry
  60                         $indexInstance = Registry::getRegistry()->getInstance($type . '_index');
  61                 } else {
  62                         // Get the handler instance
  63                         $indexInstance = self::createObjectByConfiguredName($type . '_file_stack_index_class', array($infoInstance));
  64
  65                         // Add check for interface
  66                         assert($indexInstance instanceof IndexableStack);
  67
  68                         // Add it to the registry
  69                         Registry::getRegistry()->addInstance($type . '_index', $indexInstance);
  70                 }
  71
  72                 // Return the instance
  73                 return $indexInstance;
  74         }
  75
  76 }