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

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