Continued CSV parsing:
[core.git] / inc / classes / main / file_directories / input / text / class_FrameworkTextFileInputPointer.php
1 <?php
2 /**
3  * A class for reading text files
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.org
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
23  */
24 class FrameworkTextFileInputPointer extends BaseFileIo implements InputPointer {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33         }
34
35         /**
36          * Create a file pointer based on the given file. The file will also
37          * be verified here.
38          *
39          * @param       $fileName       The file name we shall pass to fopen()
40          * @throws      FileIsEmptyException    If the provided file name is empty.
41          * @throws      FileIoException                 If fopen() returns not a file resource
42          * @return      void
43          */
44         public static final function createFrameworkTextFileInputPointer ($fileName) {
45                 // Some pre-sanity checks...
46                 if ((is_null($fileName)) || (empty($fileName))) {
47                         // No filename given
48                         throw new FileIsEmptyException(NULL, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
49                 } elseif (!file_exists($fileName)) {
50                         // File does not exist!
51                         throw new FileIoException($fileName, self::EXCEPTION_FILE_NOT_FOUND);
52                 } elseif (!is_readable($fileName)) {
53                         // File does not exist!
54                         throw new FileReadProtectedException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
55                 }
56
57                 // Try to open a handler
58                 $filePointer = fopen($fileName, 'r');
59                 if ((is_null($filePointer)) || ($filePointer === FALSE)) {
60                         // Something bad happend
61                         throw new FileIoException($fileName, self::EXCEPTION_FILE_POINTER_INVALID);
62                 } // END - if
63
64                 // Create new instance
65                 $pointerInstance = new FrameworkTextFileInputPointer();
66
67                 // Set file pointer and file name
68                 $pointerInstance->setPointer($filePointer);
69                 $pointerInstance->setFileName($fileName);
70
71                 // Return the instance
72                 return $pointerInstance;
73         }
74
75         /**
76          * Read data a file pointer
77          *
78          * @return      $data   Read data from file
79          */
80         public function readFromFile () {
81                 // Read 1024 Byte data from the file pointer and return it
82                 return $this->read(1024);
83         }
84
85         /**
86          * Reads a line, maximum 4096 Bytes from current file pointer
87          *
88          * @return      $data   Read data from file
89          */
90         public function readLine () {
91                 // Read whole line from the file pointer and return it
92                 return $this->read();
93         }
94
95         /**
96          * Reads given amount of bytes from file.
97          *
98          * @param       $bytes  Amount of bytes to read or whole line (only text files)
99          * @return      $data   Data read from file
100          * @throws      NullPointerException    If the file pointer instance
101          *                                                                      is not set by setPointer()
102          * @throws      InvalidResourceException        If there is being set
103          */
104         public function read ($bytes = NULL) {
105                 // Some sanity checks
106                 if (is_null($this->getPointer())) {
107                         // Pointer not initialized
108                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
109                 } elseif (!is_resource($this->getPointer())) {
110                         // Pointer is not a valid resource!
111                         throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
112                 }
113
114                 // Is $bytes set?
115                 if (is_int($bytes)) {
116                         // Try to read given characters
117                         $data = fgets($this->getPointer(), $bytes);
118                 } else {
119                         // Try to read whole line
120                         $data = fgets($this->getPointer());
121                 }
122
123                 // Then return it
124                 return $data;
125         }
126
127         /**
128          * Analyzes entries in index file. This will count all found (and valid)
129          * entries, mark invalid as damaged and count gaps ("fragmentation"). If
130          * only gaps are found, the file is considered as "virgin" (no entries).
131          *
132          * @return      void
133          * @throws      UnsupportedOperationException   If this method is called
134          */
135         public function analyzeFile () {
136                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
137         }
138
139         /**
140          * Advances to next "block" of bytes
141          *
142          * @return      void
143          * @throws      UnsupportedOperationException   If this method is called
144          */
145         public function next () {
146                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
147         }
148
149         /**
150          * Checks wether the current entry is valid (not at the end of the file).
151          * This method will return TRUE if an emptied (nulled) entry has been found.
152          *
153          * @return      $isValid        Whether the next entry is valid
154          * @throws      UnsupportedOperationException   If this method is called
155          */
156         public function valid () {
157                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
158         }
159
160         /**
161          * Gets current seek position ("key").
162          *
163          * @return      $key    Current key in iteration
164          * @throws      UnsupportedOperationException   If this method is called
165          */
166         public function key () {
167                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
168         }
169 }
170
171 // [EOF]
172 ?>