3 namespace Org\Mxchange\CoreFramework\Filesystem\Pointer\Input;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
7 use Org\Mxchange\CoreFramework\FileSystem\BaseFileIo;
8 use Org\Mxchange\CoreFramework\Filesystem\FileNotFoundException;
9 use Org\Mxchange\CoreFramework\FileSystem\FileReadProtectedException;
10 use Org\Mxchange\CoreFramework\Filesystem\Pointer\InputPointer;
11 use Org\Mxchange\CoreFramework\Generic\NullPointerException;
12 use Org\Mxchange\CoreFramework\Generic\UnsupportedOperationException;
13 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
16 * A class for reading text files
18 * @author Roland Haeder <webmaster@shipsimu.org>
20 <<<<<<< HEAD:framework/main/classes/file_directories/input/text/class_FrameworkTextFileInputPointer.php
21 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
23 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
24 >>>>>>> Some updates::inc/main/classes/file_directories/input/text/class_FrameworkTextFileInputPointer.php
25 * @license GNU GPL 3.0 or any newer version
26 * @link http://www.shipsimu.org
28 * This program is free software: you can redistribute it and/or modify
29 * it under the terms of the GNU General Public License as published by
30 * the Free Software Foundation, either version 3 of the License, or
31 * (at your option) any later version.
33 * This program is distributed in the hope that it will be useful,
34 * but WITHOUT ANY WARRANTY; without even the implied warranty of
35 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
36 * GNU General Public License for more details.
38 * You should have received a copy of the GNU General Public License
39 * along with this program. If not, see <http://www.gnu.org/licenses/>.
41 class FrameworkTextFileInputPointer extends BaseFileIo implements InputPointer {
43 * Protected constructor
47 protected function __construct () {
48 // Call parent constructor
49 parent::__construct(__CLASS__);
53 * Create a file pointer based on the given file. The file will also
56 * @param $fileName The file name we shall pass to fopen()
57 * @throws FileIoException If the file is not reachable
58 * @throws FileReadProtectedException If the file cannot be read from
61 public static final function createFrameworkTextFileInputPointer ($infoInstance) {
62 if (!FrameworkBootstrap::isReachableFilePath($infoInstance)) {
63 // File cannot be reached
64 throw new FileIoException($infoInstance, self::EXCEPTION_FILE_NOT_REACHABLE);
65 } elseif ((!FrameworkBootstrap::isReadableFile($infoInstance)) && (!$infoInstance->isFile())) {
66 // File does not exist!
67 throw new FileNotFoundException($infoInstance, self::EXCEPTION_FILE_CANNOT_BE_READ);
68 } elseif ((!FrameworkBootstrap::isReadableFile($infoInstance)) && ($infoInstance->isFile())) {
69 // File cannot be read from (but exists)
70 throw new FileReadProtectedException($infoInstance, self::EXCEPTION_FILE_CANNOT_BE_READ);
73 // Try to open a handler
74 $fileObject = $infoInstance->openFile('r');
75 if ((is_null($fileObject)) || ($fileObject === false)) {
76 // Something bad happend
77 throw new FileIoException($infoInstance, self::EXCEPTION_FILE_POINTER_INVALID);
80 // Create new instance
81 $pointerInstance = new FrameworkTextFileInputPointer();
83 // Set file pointer and file name
84 $pointerInstance->setPointer($fileObject);
86 // Return the instance
87 return $pointerInstance;
91 * Read data a file pointer
93 * @return $data Read data from file
95 public function readFromFile () {
96 // Read 1024 Byte data from the file pointer and return it
97 return $this->read(1024);
101 * Reads a line, maximum 4096 Bytes from current file pointer
103 * @return $data Read data from file
105 public function readLine () {
106 // Read whole line from the file pointer and return it
107 return $this->read();
111 * Reads given amount of bytes from file.
113 * @param $bytes Amount of bytes to read or whole line (only text files)
114 * @return $data Data read from file
115 * @throws NullPointerException If the file pointer instance is not set by setPointer()
116 * @throws InvalidResourceException If there is no object being set
118 public function read ($bytes = NULL) {
119 // Some sanity checks
120 if (is_null($this->getFileObject())) {
121 // Pointer not initialized
122 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
123 } elseif (!is_object($this->getFileObject())) {
124 // Pointer is not a valid resource!
125 throw new LogicException(sprintf('this->fileObject[]=%s is no object', gettype($this->getFileObject())));
129 if (is_int($bytes)) {
130 // Try to read given characters
131 $data = $this->getFileObject()->fread($bytes);
133 // Try to read whole line
134 $data = $this->getFileObject()->fgets();
142 * Analyzes entries in index file. This will count all found (and valid)
143 * entries, mark invalid as damaged and count gaps ("fragmentation"). If
144 * only gaps are found, the file is considered as "virgin" (no entries).
147 * @throws UnsupportedOperationException If this method is called
149 public function analyzeFile () {
150 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
154 * Advances to next "block" of bytes
157 * @throws UnsupportedOperationException If this method is called
159 public function next () {
160 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
164 * Checks wether the current entry is valid (not at the end of the file).
165 * This method will return true if an emptied (nulled) entry has been found.
167 * @return $isValid Whether the next entry is valid
168 * @throws UnsupportedOperationException If this method is called
170 public function valid () {
171 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
175 * Gets current seek position ("key").
177 * @return $key Current key in iteration
178 * @throws UnsupportedOperationException If this method is called
180 public function key () {
181 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);