3 namespace CoreFramework\Filesystem\File;
5 // Import framework stuff
6 use CoreFramework\Filesystem\File\BaseAbstractFile;
7 use CoreFramework\Generic\UnsupportedOperationException;
10 * A general text file class
12 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
31 class BaseTextFile extends BaseAbstractFile {
33 * Protected constructor
35 * @param $className Name of the class
38 protected function __construct ($className) {
39 // Call parent constructor
40 parent::__construct($className);
44 * Determines seek position
46 * @return $seekPosition Current seek position
48 public function determineSeekPosition () {
49 // Not possible in text files
50 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
54 * Seek to given offset (default) or other possibilities as fseek() gives.
56 * @param $offset Offset to seek to (or used as "base" for other seeks)
57 * @param $whence Added to offset (default: only use offset to seek to)
58 * @return $status Status of file seek: 0 = success, -1 = failed
60 public function seek ($offset, $whence = SEEK_SET) {
61 // Not possible in text files
62 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] offset=' . $offset . ',whence=' . $whence);
63 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
67 * Reads from a local or remote file
69 * @param $fqfn The file's FQFN we shall load
70 * @return $array An array containing all read lines
71 * @throws InvalidArrayCountException If an array has not the expected size
72 * @throws InvalidMD5ChecksumException If two MD5 hashes did not match
74 public function loadFileContents ($fqfn) {
76 * This class (or its implementations) are special file readers/writers.
77 * There is no need to read/write the whole file.
79 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] fqfn=' . $fqfn);
80 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);