Added missing methods (required by interfaces). They are all not used here.
[core.git] / inc / classes / main / file_directories / text / class_BaseTextFile.php
index 8f2afc9f2ed66167ba68b6264bc21eadc4d7702c..1c15afa01945f5af86f3259abfca4f9c732af26a 100644 (file)
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -32,6 +32,46 @@ class BaseTextFile extends BaseFile {
                // Call parent constructor
                parent::__construct($className);
        }
+
+       /**
+        * Determines seek position
+        *
+        * @return      $seekPosition   Current seek position
+        */
+       public function determineSeekPosition () {
+               // Not possible in text files
+               throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
+       }
+
+       /**
+        * Seek to given offset (default) or other possibilities as fseek() gives.
+        *
+        * @param       $offset         Offset to seek to (or used as "base" for other seeks)
+        * @param       $whence         Added to offset (default: only use offset to seek to)
+        * @return      $status         Status of file seek: 0 = success, -1 = failed
+        */
+       public function seek ($offset, $whence = SEEK_SET) {
+               // Not possible in text files
+               self::createDebugInstance(__CLASS__)->debugOutput('offset=' . $offset . ',whence=' . $whence);
+               throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
+       }
+
+       /**
+        * Reads from a local or remote file
+        *
+        * @param       $fqfn   The file's FQFN we shall load
+        * @return      $array  An array containing all read lines
+        * @throws      InvalidArrayCountException      If an array has not the expected size
+        * @throws      InvalidMD5ChecksumException     If two MD5 hashes did not match
+        */
+       public function loadFileContents ($fqfn) {
+               /*
+                * This class (or its implementations) are special file readers/writers.
+                * There is no need to read/write the whole file.
+                */
+               self::createDebugInstance(__CLASS__)->debugOutput('fqfn=' . $fqfn);
+               throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
+       }
 }
 
 // [EOF]