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

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