3 namespace CoreFramework\Factory\Filesystem\Stack;
6 * A factory class for file-based stack indexes
8 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
27 class FileStackIndexFactory extends ObjectFactory {
29 * Protected constructor
33 protected function __construct () {
34 // Call parent constructor
35 parent::__construct(__CLASS__);
39 * Returns a singleton (registry-based) StackableFile instance
41 * @param $stackName Name of the stack's file
42 * @return $indexInstance An instance of a IndexableStack class
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');
50 // Get the handler instance
51 $indexInstance = self::createObjectByConfiguredName($type . '_file_stack_index_class', array($fileName));
53 // Add check for interface
54 assert($indexInstance instanceof IndexableStack);
56 // Add it to the registry
57 Registry::getRegistry()->addInstance($type . '_index', $indexInstance);
60 // Return the instance
61 return $indexInstance;