framework/main/classes/index/class_

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Index\!!!;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Index\BaseIndex;
   7 use Org\Mxchange\CoreFramework\Index\Indexable;
   8
   9 // Import SPL stuff
  10 use \SplFileInfo;
  11
  12 /**
  13  * A ??? index class
  14  *
  15  * @author              Roland Haeder <webmaster@ship-simu.org>
  16  * @version             0.0.0
  17  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 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 ???Index extends BaseIndex implements Indexable, Registerable {
  35         /**
  36          * Protected constructor
  37          *
  38          * @return      void
  39          */
  40         private function __construct () {
  41                 // Call parent constructor
  42                 parent::__construct(__CLASS__);
  43         }
  44
  45         /**
  46          * Creates an instance of this Index class and prepares it for usage
  47          *
  48          * @param       $fileName               Name of the file stack to create an index file for
  49          * @return      $indexInstance  An instance of this Index class
  50          */
  51         public final static function create???Index (SplFileInfo $fileInfoInstance) {
  52                 // Get a new instance
  53                 $indexInstance = new ???Index();
  54
  55                 // Initialize index
  56                 $indexInstance->initIndex($fileInfoInstance);
  57
  58                 // Return the prepared instance
  59                 return $indexInstance;
  60         }
  61
  62 }