df10a1c84f0cb742b4067faf1c08402d7fd91443
[core.git] / inc / classes / main / factories / index / class_FileStackIndexFactory.php
1 <?php
2 /**
3  * A factory class for file-based stack indexes
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub 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 FileStackIndexFactory 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       $stackName                      Name of the stack's file
39          * @return      $indexInstance          An instance of a IndexableStack class
40          */
41         public static final function createFileStackIndexInstance ($fileName, $type) {
42                 // If there is no handler?
43                 if (Registry::getRegistry()->instanceExists($type . '_index')) {
44                         // Get handler from registry
45                         $indexInstance = Registry::getRegistry()->getInstance($type . '_index');
46                 } else {
47                         // Get the handler instance
48                         $indexInstance = self::createObjectByConfiguredName('file_stack_' . $type . '_index_class', array($fileName));
49
50                         // Add it to the registry
51                         Registry::getRegistry()->addInstance($type . '_index', $indexInstance);
52                 }
53
54                 // Return the instance
55                 return $indexInstance;
56         }
57 }
58
59 // [EOF]
60 ?>