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

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Factory\Filesystem\Stack;
   4
   5 // Import framework stuff
   6 use CoreFramework\Factory\ObjectFactory;
   7 use CoreFramework\Registry\Generic\Registry;
   8
   9 /**
  10  * A factory class for file-based stack indexes
  11  *
  12  * @author              Roland Haeder <webmaster@ship-simu.org>
  13  * @version             0.0.0
  14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  15  * @license             GNU GPL 3.0 or any newer version
  16  * @link                http://www.ship-simu.org
  17  *
  18  * This program is free software: you can redistribute it and/or modify
  19  * it under the terms of the GNU General Public License as published by
  20  * the Free Software Foundation, either version 3 of the License, or
  21  * (at your option) any later version.
  22  *
  23  * This program is distributed in the hope that it will be useful,
  24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  * GNU General Public License for more details.
  27  *
  28  * You should have received a copy of the GNU General Public License
  29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  30  */
  31 class FileStackIndexFactory extends ObjectFactory {
  32         /**
  33          * Protected constructor
  34          *
  35          * @return      void
  36          */
  37         protected function __construct () {
  38                 // Call parent constructor
  39                 parent::__construct(__CLASS__);
  40         }
  41
  42         /**
  43          * Returns a singleton (registry-based) StackableFile instance
  44          *
  45          * @param       $stackName                      Name of the stack's file
  46          * @return      $indexInstance          An instance of a IndexableStack class
  47          */
  48         public static final function createFileStackIndexInstance ($fileName, $type) {
  49                 // If there is no handler?
  50                 if (Registry::getRegistry()->instanceExists($type . '_index')) {
  51                         // Get handler from registry
  52                         $indexInstance = Registry::getRegistry()->getInstance($type . '_index');
  53                 } else {
  54                         // Get the handler instance
  55                         $indexInstance = self::createObjectByConfiguredName($type . '_file_stack_index_class', array($fileName));
  56
  57                         // Add check for interface
  58                         assert($indexInstance instanceof IndexableStack);
  59
  60                         // Add it to the registry
  61                         Registry::getRegistry()->addInstance($type . '_index', $indexInstance);
  62                 }
  63
  64                 // Return the instance
  65                 return $indexInstance;
  66         }
  67
  68 }