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