3 namespace CoreFramework\Factory\Filesystem\Stack;
5 // Import framework stuff
6 use CoreFramework\Factory\ObjectFactory;
7 use CoreFramework\Registry\Registry;
10 * A factory class for file-based stack indexes
12 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
31 class FileStackIndexFactory extends ObjectFactory {
33 * Protected constructor
37 protected function __construct () {
38 // Call parent constructor
39 parent::__construct(__CLASS__);
43 * Returns a singleton (registry-based) StackableFile instance
45 * @param $stackName Name of the stack's file
46 * @return $indexInstance An instance of a IndexableStack class
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');
54 // Get the handler instance
55 $indexInstance = self::createObjectByConfiguredName($type . '_file_stack_index_class', array($fileName));
57 // Add check for interface
58 assert($indexInstance instanceof IndexableStack);
60 // Add it to the registry
61 Registry::getRegistry()->addInstance($type . '_index', $indexInstance);
64 // Return the instance
65 return $indexInstance;