3 namespace CoreFramework\Factory\Stack;
5 // Import framework stuff
6 use CoreFramework\Configuration\FrameworkConfiguration;
7 use CoreFramework\Factory\ObjectFactory;
8 use CoreFramework\Registry\Registry;
11 * A factory class for file-based stacks
13 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
32 class FileStackFactory extends ObjectFactory {
34 * Protected constructor
38 protected function __construct () {
39 // Call parent constructor
40 parent::__construct(__CLASS__);
44 * Returns a singleton (registry-based) StackableFile instance
46 * @param $prefix Class prefix
47 * @param $stackName Name of the stack
48 * @return $stackInstance An instance of a StackableFile class
50 public static final function createFileStackInstance ($prefix, $stackName) {
51 // Construct file stack name
52 $stackFileName = sprintf('%s%s/%s.%s',
53 FrameworkConfiguration::getSelfInstance()->getConfigEntry('framework_base_path'),
54 FrameworkConfiguration::getSelfInstance()->getConfigEntry('base_file_stacks_path'),
56 FrameworkConfiguration::getSelfInstance()->getConfigEntry('file_stacks_extension')
59 // If there is no handler?
60 if (Registry::getRegistry()->instanceExists($stackName . '_stack')) {
61 // Get handler from registry
62 $stackInstance = Registry::getRegistry()->getInstance($stackName . '_stack');
64 // Get the handler instance
65 $stackInstance = self::createObjectByConfiguredName($prefix . '_' . $stackName . '_stack_class', array($stackFileName, $prefix . '_' . $stackName));
67 // Add it to the registry
68 Registry::getRegistry()->addInstance($stackName . '_stack', $stackInstance);
71 // Return the instance
72 return $stackInstance;