3 namespace CoreFramework\Filesystem\File;
5 // Import framework stuff
6 use CoreFramework\Generic\UnsupportedOperationException;
9 * A general text file class
11 * @author Roland Haeder <webmaster@ship-simu.org>
13 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
14 * @license GNU GPL 3.0 or any newer version
15 * @link http://www.ship-simu.org
17 * This program is free software: you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation, either version 3 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 class BaseTextFile extends BaseAbstractFile {
32 * Protected constructor
34 * @param $className Name of the class
37 protected function __construct ($className) {
38 // Call parent constructor
39 parent::__construct($className);
43 * Determines seek position
45 * @return $seekPosition Current seek position
47 public function determineSeekPosition () {
48 // Not possible in text files
49 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
53 * Seek to given offset (default) or other possibilities as fseek() gives.
55 * @param $offset Offset to seek to (or used as "base" for other seeks)
56 * @param $whence Added to offset (default: only use offset to seek to)
57 * @return $status Status of file seek: 0 = success, -1 = failed
59 public function seek ($offset, $whence = SEEK_SET) {
60 // Not possible in text files
61 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] offset=' . $offset . ',whence=' . $whence);
62 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
66 * Reads from a local or remote file
68 * @param $fqfn The file's FQFN we shall load
69 * @return $array An array containing all read lines
70 * @throws InvalidArrayCountException If an array has not the expected size
71 * @throws InvalidMD5ChecksumException If two MD5 hashes did not match
73 public function loadFileContents ($fqfn) {
75 * This class (or its implementations) are special file readers/writers.
76 * There is no need to read/write the whole file.
78 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] fqfn=' . $fqfn);
79 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);