]> git.mxchange.org Git - core.git/blob - framework/main/classes/factories/index/class_FileStackIndexFactory.php
Continued:
[core.git] / framework / main / classes / factories / index / class_FileStackIndexFactory.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Factory\Filesystem\Stack;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
7 use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
8
9 // Import SPL stuff
10 use \SplFileInfo;
11
12 /**
13  * A factory class for file-based stack indexes
14  *
15  * @author              Roland Haeder <webmaster@ship-simu.org>
16  * @version             0.0.0
17  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
18  * @license             GNU GPL 3.0 or any newer version
19  * @link                http://www.ship-simu.org
20  *
21  * This program is free software: you can redistribute it and/or modify
22  * it under the terms of the GNU General Public License as published by
23  * the Free Software Foundation, either version 3 of the License, or
24  * (at your option) any later version.
25  *
26  * This program is distributed in the hope that it will be useful,
27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
29  * GNU General Public License for more details.
30  *
31  * You should have received a copy of the GNU General Public License
32  * along with this program. If not, see <http://www.gnu.org/licenses/>.
33  */
34 class FileStackIndexFactory extends ObjectFactory {
35         /**
36          * Protected constructor
37          *
38          * @return      void
39          */
40         protected function __construct () {
41                 // Call parent constructor
42                 parent::__construct(__CLASS__);
43         }
44
45         /**
46          * Returns a singleton (registry-based) StackableFile instance
47          *
48          * @param       $infoInstance   An instance of a SplFileInfo class
49          * @return      $indexInstance  An instance of a IndexableStack class
50          */
51         public static final function createFileStackIndexInstance (SplFileInfo $infoInstance, string $type) {
52                 // If there is no handler?
53                 if (GenericRegistry::getRegistry()->instanceExists($type . '_index')) {
54                         // Get handler from registry
55                         $indexInstance = GenericRegistry::getRegistry()->getInstance($type . '_index');
56                 } else {
57                         // Get the handler instance
58                         $indexInstance = self::createObjectByConfiguredName($type . '_file_stack_index_class', array($infoInstance));
59
60                         // Add it to the registry
61                         GenericRegistry::getRegistry()->addInstance($type . '_index', $indexInstance);
62                 }
63
64                 // Return the instance
65                 return $indexInstance;
66         }
67
68 }