Copyright year updated, converted double->single quotes

[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 533dce3e2fb0b7744dd4fa4c6b968c7c0c8656c9..55f98f8e636f580bb5870b1c0f8c843c1c99f9c6 100644 (file)
--- a/inc/classes/middleware/io/class_FileIoHandler.php
+++ b/inc/classes/middleware/io/class_FileIoHandler.php
@@ -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 - 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.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
         */
@@ -119,19 +119,27 @@ class FileIoHandler extends BaseMiddleware {
        /**
         * Saves a file with data by using the current output stream
         *
-        * @param       $fileName               Name of the file
-        * @param       $dataStream             File data stream
+        * @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, $dataStream) {
+       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(
-                       // @TODO What is this for?
-                       0 => $this->__toString(),
+                       0 => $className,
                        1 => $dataStream
                );
 
@@ -141,8 +149,8 @@ class FileIoHandler extends BaseMiddleware {
 
        /** 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