]> git.mxchange.org Git - core.git/blob - framework/main/classes/index/class_
Continued:
[core.git] / framework / main / classes / index / class_
1 <?php
2 // Own namespace
3 namespace CoreFramework\Index\!!!;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Index\BaseIndex;
7 use Org\Mxchange\CoreFramework\Index\Indexable;
8
9 /**
10  * A ??? index class
11  *
12  * @author              Roland Haeder <webmaster@ship-simu.org>
13  * @version             0.0.0
14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
15  * @license             GNU GPL 3.0 or any newer version
16  * @link                http://www.ship-simu.org
17  *
18  * This program is free software: you can redistribute it and/or modify
19  * it under the terms of the GNU General Public License as published by
20  * the Free Software Foundation, either version 3 of the License, or
21  * (at your option) any later version.
22  *
23  * This program is distributed in the hope that it will be useful,
24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
26  * GNU General Public License for more details.
27  *
28  * You should have received a copy of the GNU General Public License
29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
30  */
31 class ???Index extends BaseIndex implements Indexable, Registerable {
32         /**
33          * Protected constructor
34          *
35          * @return      void
36          */
37         protected function __construct () {
38                 // Call parent constructor
39                 parent::__construct(__CLASS__);
40         }
41
42         /**
43          * Creates an instance of this Index class and prepares it for usage
44          *
45          * @param       $fileName               Name of the file stack to create an index file for
46          * @return      $indexInstance  An instance of this Index class
47          */
48         public final static function create???Index ($fileName) {
49                 // Get a new instance
50                 $indexInstance = new ???Index();
51
52                 // Initialize index
53                 $indexInstance->initIndex($fileName);
54
55                 // Return the prepared instance
56                 return $indexInstance;
57         }
58
59 }