Continued:
[core.git] / framework / main / classes / index / class_
1 <?php
2 /**
3  * A ??? index class
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 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 ???Index extends BaseIndex implements Indexable, Registerable {
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          * Creates an instance of this Index class and prepares it for usage
37          *
38          * @param       $fileName               Name of the file stack to create an index file for
39          * @return      $indexInstance  An instance of this Index class
40          */
41         public final static function create???Index ($fileName) {
42                 // Get a new instance
43                 $indexInstance = new ???Index();
44
45                 // Initialize index
46                 $indexInstance->initIndex($fileName);
47
48                 // Return the prepared instance
49                 return $indexInstance;
50         }
51
52 }