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