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 // Import SPL stuff
  10 use \SplFileInfo;
  11
  12 /**
  13  * A general text input file class
  14  *
  15  * @author              Roland Haeder <webmaster@ship-simu.org>
  16  * @version             0.0.0
  17  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2019 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 abstract class BaseInputTextFile extends BaseTextFile {
  35         /**
  36          * Protected constructor
  37          *
  38          * @param       $className      Name of the class
  39          * @return      void
  40          */
  41         protected function __construct ($className) {
  42                 // Call parent constructor
  43                 parent::__construct($className);
  44         }
  45
  46         /**
  47          * Initializes this text file for reading
  48          *
  49          * @param       $infoInstance   An instance of a SplFileInfo class
  50          * @return      void
  51          */
  52         protected function initFile (SplFileInfo $infoInstance) {
  53                 // Get a file i/o pointer instance
  54                 $pointerInstance = ObjectFactory::createObjectByConfiguredName('text_file_input_class', array($infoInstance));
  55
  56                 // ... and set it here
  57                 $this->setPointerInstance($pointerInstance);
  58         }
  59
  60         /**
  61          * Reads a line from currently referenced file
  62          *
  63          * @return      $data   Read data from referenced file
  64          */
  65         public function readLine () {
  66         }
  67
  68 }