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\GenericRegistry;
   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  * @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 FileStackIndexFactory 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       $infoInstance   An instance of a SplFileInfo class
  50          * @return      $indexInstance  An instance of a IndexableStack class
  51          */
  52         public static final function createFileStackIndexInstance (SplFileInfo $infoInstance, $type) {
  53                 // If there is no handler?
  54                 if (GenericRegistry::getRegistry()->instanceExists($type . '_index')) {
  55                         // Get handler from registry
  56                         $indexInstance = GenericRegistry::getRegistry()->getInstance($type . '_index');
  57                 } else {
  58                         // Get the handler instance
  59                         $indexInstance = self::createObjectByConfiguredName($type . '_file_stack_index_class', array($infoInstance));
  60
  61                         // Add check for interface
  62                         assert($indexInstance instanceof IndexableStack);
  63
  64                         // Add it to the registry
  65                         Registry::getRegistry()->addInstance($type . '_index', $indexInstance);
  66                 }
  67
  68                 // Return the instance
  69                 return $indexInstance;
  70         }
  71
  72 }