3 * A factory class for file-based stacks
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class FileStackFactory extends ObjectFactory {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Returns a singleton (registry-based) StackableFile instance
38 * @param $prefix Class prefix
39 * @param $stackName Name of the stack
40 * @return $stackInstance An instance of a StackableFile class
42 public static final function createFileStackInstance ($prefix, $stackName) {
43 // Construct file stack name
44 $stackFileName = sprintf('%s%s/%s.%s',
45 FrameworkConfiguration::getSelfInstance()->getConfigEntry('base_path'),
46 FrameworkConfiguration::getSelfInstance()->getConfigEntry('base_file_stacks_path'),
48 FrameworkConfiguration::getSelfInstance()->getConfigEntry('file_stacks_extension')
51 // If there is no handler?
52 if (Registry::getRegistry()->instanceExists($stackName . '_stack')) {
53 // Get handler from registry
54 $stackInstance = Registry::getRegistry()->getInstance($stackName . '_stack');
56 // Get the handler instance
57 $stackInstance = self::createObjectByConfiguredName($prefix . '_' . $stackName . '_stack_class', array($stackFileName, $prefix . '_' . $stackName));
59 // Add it to the registry
60 Registry::getRegistry()->addInstance($stackName . '_stack', $stackInstance);
63 // Return the instance
64 return $stackInstance;