Renamed Registry -> GenericRegistry to make it clear that this registry does

[core.git] / framework / main / middleware / io / class_FileIoHandler.php

diff --git a/framework/main/middleware/io/class_FileIoHandler.php b/framework/main/middleware/io/class_FileIoHandler.php
index 0682e0376c912e34801a1a930de1014a9af158d1..350151943e97307a1877e024236bc4976c3fab69 100644 (file)
--- a/framework/main/middleware/io/class_FileIoHandler.php
+++ b/framework/main/middleware/io/class_FileIoHandler.php
@@ -1,15 +1,18 @@
 <?php
 // Own namespace
-namespace CoreFramework\Handler\Filesystem;
+namespace Org\Mxchange\CoreFramework\Handler\Filesystem;
 
 // Import framework stuff
-use CoreFramework\Factory\ObjectFactory;
-use CoreFramework\Generic\FrameworkInterface;
-use CoreFramework\Generic\UnsupportedOperationException;
-use CoreFramework\Handler\Stream\IoHandler;
-use CoreFramework\Middleware\BaseMiddleware;
-use CoreFramework\Stream\Filesystem\FileInputStreamer;
-use CoreFramework\Stream\Filesystem\FileOutputStreamer;
+use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
+use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
+use Org\Mxchange\CoreFramework\Generic\UnsupportedOperationException;
+use Org\Mxchange\CoreFramework\Handler\Stream\IoHandler;
+use Org\Mxchange\CoreFramework\Middleware\BaseMiddleware;
+use Org\Mxchange\CoreFramework\Stream\Filesystem\FileInputStreamer;
+use Org\Mxchange\CoreFramework\Stream\Filesystem\FileOutputStreamer;
+
+// Import SPL stuff
+use \SplFileInfo;
 
 /**
  * This is a file IO handler. It handles reading from and writing to files.
@@ -131,25 +134,25 @@ class FileIoHandler extends BaseMiddleware implements IoHandler {
         * Saves streamed (that are mostly serialized objects) data to files or
         * external servers.
         *
-        * @param       $fileName       The local file's name including full path
+        * @param       $infoInstance   An instance of a SplFileInfo class
         * @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__, __LINE__)->debugOutput('fileName=' . $fileName . ',dataArray()=' . count($dataArray));
+       public function saveFile (SplFileInfo $infoInstance, array $dataArray) {
+               self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('infoInstance.pathname=' . $infoInstance->getPathname() . ',dataArray()=' . count($dataArray));
                throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
        }
 
        /**
         * Saves a file with data by using the current output stream
         *
-        * @param       $fileName                       Name of the file
+        * @param       $infoInstance           An instance of a SplFileInfo class
         * @param       $dataStream                     File data stream
         * @param       $objectInstance         An instance of a FrameworkInterface class (default: NULL)
         * @return      void
         */
-       public function saveStreamToFile ($fileName, $dataStream, FrameworkInterface $objectInstance = NULL) {
+       public function saveStreamToFile (SplFileInfo $infoInstance, $dataStream, FrameworkInterface $objectInstance = NULL) {
                // Default is this array
                $className = $this->__toString();
 
@@ -165,18 +168,18 @@ class FileIoHandler extends BaseMiddleware implements IoHandler {
                        1 => $dataStream
                );
 
-               // Send the fileName and dataArray to the output handler
-               $this->getOutputStream()->saveFile($fileName, $dataArray);
+               // Send the infoInstance and dataArray to the output handler
+               $this->getOutputStream()->saveFile($infoInstance, $dataArray);
        }
 
        /** Loads data from a file over the input handler
         *
-        * @param       $fqfn   Given full-qualified file name (FQFN) to load
+        * @param       $infoInstance   An instance of a SplFileInfo class
         * @return      $array  Array with the file contents
         */
-       public function loadFileContents ($fqfn) {
+       public function loadFileContents (SplFileInfo $infoInstance) {
                // Read from the input handler
-               return $this->getInputStream()->loadFileContents($fqfn);
+               return $this->getInputStream()->loadFileContents($infoInstance);
        }
 
        /**
@@ -209,4 +212,34 @@ class FileIoHandler extends BaseMiddleware implements IoHandler {
                $this->partialStub();
        }
 
+       /**
+        * "Getter" for seek position
+        *
+        * @return      $seekPosition   Current seek position
+        * @todo        0% done
+        */
+       public function getPosition () {
+               $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();
+       }
+
 }