3 namespace Org\Mxchange\CoreFramework\Factory\Stack\File;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Factory\Object\ObjectFactory;
7 use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
10 use \InvalidArgumentException;
14 * A factory class for file-based stack indexes
16 * @author Roland Haeder <webmaster@ship-simu.org>
18 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
19 * @license GNU GPL 3.0 or any newer version
20 * @link http://www.ship-simu.org
22 * This program is free software: you can redistribute it and/or modify
23 * it under the terms of the GNU General Public License as published by
24 * the Free Software Foundation, either version 3 of the License, or
25 * (at your option) any later version.
27 * This program is distributed in the hope that it will be useful,
28 * but WITHOUT ANY WARRANTY; without even the implied warranty of
29 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30 * GNU General Public License for more details.
32 * You should have received a copy of the GNU General Public License
33 * along with this program. If not, see <http://www.gnu.org/licenses/>.
35 class FileStackIndexFactory extends ObjectFactory {
37 * Protected constructor
41 protected function __construct () {
42 // Call parent constructor
43 parent::__construct(__CLASS__);
47 * Returns a singleton (registry-based) StackableFile instance
49 * @param $infoInstance An instance of a SplFileInfo class
50 * @return $indexInstance An instance of a IndexableStack class
51 * @throws InvalidArgumentException If a parameter is invalid
53 public static final function createFileStackIndexInstance (SplFileInfo $infoInstance, string $type) {
54 // If there is no handler?
57 throw new InvalidArgumentException('Parameter "type" is empty');
58 } elseif (GenericRegistry::getRegistry()->instanceExists($type . '_index')) {
59 // Get handler from registry
60 $indexInstance = GenericRegistry::getRegistry()->getInstance($type . '_index');
62 // Get the handler instance
63 $indexInstance = self::createObjectByConfiguredName($type . '_file_stack_index_class', array($infoInstance));
65 // Add it to the registry
66 GenericRegistry::getRegistry()->addInstance($type . '_index', $indexInstance);
69 // Return the instance
70 return $indexInstance;