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

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