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