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