Renamed classes/main/ to main/classes/ + added FuseFeature, an upcoming feature
[core.git] / inc / main / classes / factories / stacks / class_FileStackFactory.php
1 <?php
2 /**
3  * A factory class for file-based stacks
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
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
10  *
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.
15  *
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.
20  *
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/>.
23  */
24 class FileStackFactory extends ObjectFactory {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33         }
34
35         /**
36          * Returns a singleton (registry-based) StackableFile instance
37          *
38          * @param       $prefix                         Class prefix
39          * @param       $stackName                      Name of the stack
40          * @return      $stackInstance          An instance of a StackableFile class
41          */
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'),
47                         $stackName,
48                         FrameworkConfiguration::getSelfInstance()->getConfigEntry('file_stacks_extension')
49                 );
50
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');
55                 } else {
56                         // Get the handler instance
57                         $stackInstance = self::createObjectByConfiguredName($prefix . '_' . $stackName . '_stack_class', array($stackFileName, $prefix . '_' . $stackName));
58
59                         // Add it to the registry
60                         Registry::getRegistry()->addInstance($stackName . '_stack', $stackInstance);
61                 }
62
63                 // Return the instance
64                 return $stackInstance;
65         }
66 }
67
68 // [EOF]
69 ?>