Updated domain without a dash :(
[core.git] / inc / classes / middleware / io / class_FileIoHandler.php
index 22dff80329e9e95fa96c8cee61eea8403d64e8a7..38b9bc1af693e2e72db39c56c7f2dff1eb26ed07 100644 (file)
@@ -3,11 +3,11 @@
  * This is a file IO handler. It handles reading from and writing to files.
  * Missing paths in writing process will be automatically created.
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @link               http://www.shipsimu.org
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -22,7 +22,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-class FileIoHandler extends BaseMiddleware {
+class FileIoHandler extends BaseMiddleware implements IoHandler {
        /**
         * The *real* file input class we shall use for reading data
         */
@@ -36,7 +36,7 @@ class FileIoHandler extends BaseMiddleware {
        /**
         * An instance of this class
         */
-       private static $thisInstance = NULL;
+       private static $selfInstance = NULL;
 
        /**
         * Protected constructor
@@ -48,7 +48,7 @@ class FileIoHandler extends BaseMiddleware {
                parent::__construct(__CLASS__);
 
                // Set own instance
-               self::$thisInstance = $this;
+               self::$selfInstance = $this;
        }
 
        /**
@@ -72,10 +72,10 @@ class FileIoHandler extends BaseMiddleware {
        /**
         * Getter for an instance of this class
         *
-        * @return      $thisInstance   An instance of this class
+        * @return      $selfInstance   An instance of this class
         */
-       public static final function getInstance () {
-               return self::$thisInstance;
+       public static final function getSelfInstance () {
+               return self::$selfInstance;
        }
 
        /**
@@ -119,23 +119,38 @@ class FileIoHandler extends BaseMiddleware {
        /**
         * Saves a file with data by using the current output stream
         *
-        * @param       $fileName       Name of the file
-        * @param       $dataArray      Array with file contents
+        * @param       $fileName                       Name of the file
+        * @param       $dataStream                     File data stream
+        * @param       $objectInstance         An instance of a FrameworkInterface class (default: NULL)
         * @return      void
-        * @see         FileOutputStreamer
         */
-       public function saveFile ($fileName, $dataArray) {
+       public function saveFile ($fileName, $dataStream, FrameworkInterface $objectInstance = NULL) {
                // Get output stream
                $outInstance = $this->getOutputStream();
 
+               // Default is this array
+               $className = $this->__toString();
+
+               // Is the object instance set?
+               if ($objectInstance instanceof FrameworkInterface) {
+                       // Then use this
+                       $className = $objectInstance->__toString();
+               } // END - if
+
+               // Prepare output array
+               $dataArray = array(
+                       0 => $className,
+                       1 => $dataStream
+               );
+
                // Send the fileName and dataArray to the output handler
                $outInstance->saveFile($fileName, $dataArray);
        }
 
        /** Loads data from a file over the input handler
         *
+        * @param       $fqfn   Given full-qualified file name (FQFN) to load
         * @return      $array  Array with the file contents
-        * @see         FileInputStreamer
         */
        public function loadFileContents ($fqfn) {
                // Get output stream