Renamed one getSeekPosition() to determineSeekPosition().

[core.git] / inc / classes / middleware / io / class_FileIoHandler.php

diff --git a/inc/classes/middleware/io/class_FileIoHandler.php b/inc/classes/middleware/io/class_FileIoHandler.php
index 38b9bc1af693e2e72db39c56c7f2dff1eb26ed07..d8882a726b9a4f121b785af53de9cc49438e1982 100644 (file)
--- a/inc/classes/middleware/io/class_FileIoHandler.php
+++ b/inc/classes/middleware/io/class_FileIoHandler.php
@@ -5,7 +5,7 @@
  *
  * @author             Roland Haeder <webmaster@shipsimu.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 - 2013 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.shipsimu.org
  *
@@ -115,6 +115,19 @@ class FileIoHandler extends BaseMiddleware implements IoHandler {
        public final function getOutputStream () {
                return $this->outputStream;
        }
+       /**
+        * Saves streamed (that are mostly serialized objects) data to files or
+        * external servers.
+        *
+        * @param       $fileName       The local file's name including full path
+        * @param       $dataArray      Array containing the compressor's extension and streamed data
+        * @return      void
+        * @throws      UnsupportedOperationException   If this method is called
+        */
+       public function saveFile ($fileName, array $dataArray) {
+               self::createDebugInstance(__CLASS__)->debugOutput('fileName=' . $fileName . ',dataArray()=' . count($dataArray));
+               throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
+       }
 
        /**
         * Saves a file with data by using the current output stream
@@ -124,10 +137,7 @@ class FileIoHandler extends BaseMiddleware implements IoHandler {
         * @param       $objectInstance         An instance of a FrameworkInterface class (default: NULL)
         * @return      void
         */
-       public function saveFile ($fileName, $dataStream, FrameworkInterface $objectInstance = NULL) {
-               // Get output stream
-               $outInstance = $this->getOutputStream();
-
+       public function saveStreamToFile ($fileName, $dataStream, FrameworkInterface $objectInstance = NULL) {
                // Default is this array
                $className = $this->__toString();
 
@@ -144,7 +154,7 @@ class FileIoHandler extends BaseMiddleware implements IoHandler {
                );
 
                // Send the fileName and dataArray to the output handler
-               $outInstance->saveFile($fileName, $dataArray);
+               $this->getOutputStream()->saveFile($fileName, $dataArray);
        }
 
        /** Loads data from a file over the input handler
@@ -153,11 +163,38 @@ class FileIoHandler extends BaseMiddleware implements IoHandler {
         * @return      $array  Array with the file contents
         */
        public function loadFileContents ($fqfn) {
-               // Get output stream
-               $inInstance = $this->getInputStream();
-
                // Read from the input handler
-               return $inInstance->loadFileContents($fqfn);
+               return $this->getInputStream()->loadFileContents($fqfn);
+       }
+
+       /**
+        * Determines seek position
+        *
+        * @return      $seekPosition   Current seek position
+        * @todo        0% done
+        */
+       public function determineSeekPosition () {
+               $this->partialStub();
+       }
+
+       /**
+        * 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) {
+               $this->partialStub('offset=' . $offset . ',whence=' . $whence);
+       }
+
+       /**
+        * Size of file stack
+        *
+        * @return      $size   Size (in bytes) of file
+        */
+       public function size () {
+               $this->partialStub();
        }
 }