inc/main/classes/file_directories/text/input/class_BaseInputTextFile.php

   1 <?php
   2 /**
   3  * A general text input file 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 BaseInputTextFile extends BaseTextFile {
  25         /**
  26          * Protected constructor
  27          *
  28          * @param       $className      Name of the class
  29          * @return      void
  30          */
  31         protected function __construct ($className) {
  32                 // Call parent constructor
  33                 parent::__construct($className);
  34         }
  35
  36         /**
  37          * Initializes this text file for reading
  38          *
  39          * @param       $fileName       File's name
  40          * @return      void
  41          */
  42         protected function initFile ($fileName) {
  43                 // Get a file i/o pointer instance
  44                 $pointerInstance = ObjectFactory::createObjectByConfiguredName('text_file_input_class', array($fileName));
  45
  46                 // ... and set it here
  47                 $this->setPointerInstance($pointerInstance);
  48         }
  49
  50         /**
  51          * Reads a line from currently referenced file
  52          *
  53          * @return      $data   Read data from referenced file
  54          */
  55         public function readLine () {
  56         }
  57 }
  58
  59 // [EOF]
  60 ?>