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

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Filesystem\Text;
   4
   5 /**
   6  * A general text input file class
   7  *
   8  * @author              Roland Haeder <webmaster@ship-simu.org>
   9  * @version             0.0.0
  10  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  11  * @license             GNU GPL 3.0 or any newer version
  12  * @link                http://www.ship-simu.org
  13  *
  14  * This program is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation, either version 3 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  26  */
  27 class BaseInputTextFile extends BaseTextFile {
  28         /**
  29          * Protected constructor
  30          *
  31          * @param       $className      Name of the class
  32          * @return      void
  33          */
  34         protected function __construct ($className) {
  35                 // Call parent constructor
  36                 parent::__construct($className);
  37         }
  38
  39         /**
  40          * Initializes this text file for reading
  41          *
  42          * @param       $fileName       File's name
  43          * @return      void
  44          */
  45         protected function initFile ($fileName) {
  46                 // Get a file i/o pointer instance
  47                 $pointerInstance = ObjectFactory::createObjectByConfiguredName('text_file_input_class', array($fileName));
  48
  49                 // ... and set it here
  50                 $this->setPointerInstance($pointerInstance);
  51         }
  52
  53         /**
  54          * Reads a line from currently referenced file
  55          *
  56          * @return      $data   Read data from referenced file
  57          */
  58         public function readLine () {
  59         }
  60
  61 }