inc/classes/middleware/io/class_FileIoHandler.php

   1 <?php
   2 /**
   3  * This is a file IO handler. It handles reading from and writing to files.
   4  * Missing paths in writing process will be automatically created.
   5  *
   6  * @author              Roland Haeder <webmaster@shipsimu.org>
   7  * @version             0.0.0
   8  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
   9  * @license             GNU GPL 3.0 or any newer version
  10  * @link                http://www.shipsimu.org
  11  *
  12  * This program is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation, either version 3 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  24  */
  25 class FileIoHandler extends BaseMiddleware implements IoHandler {
  26         /**
  27          * The *real* file input class we shall use for reading data
  28          */
  29         private $inputStream = NULL;
  30
  31         /**
  32          * The *real* file output class we shall use for reading data
  33          */
  34         private $outputStream = NULL;
  35
  36         /**
  37          * An instance of this class
  38          */
  39         private static $selfInstance = NULL;
  40
  41         /**
  42          * Protected constructor
  43          *
  44          * @return      void
  45          */
  46         protected function __construct () {
  47                 // Call parent constructor
  48                 parent::__construct(__CLASS__);
  49
  50                 // Set own instance
  51                 self::$selfInstance = $this;
  52         }
  53
  54         /**
  55          * Creates an instance of this class and prepares the IO system. This is
  56          * being done by setting the default file IO class
  57          *
  58          * @return      $ioInstance             A prepared instance of FilIOHandler
  59          */
  60         public static final function createFileIoHandler () {
  61                 // Get instance
  62                 $ioHandler = new FileIoHandler();
  63
  64                 // Set the *real* file IO instances (both the same)
  65                 $ioHandler->setInputStream(ObjectFactory::createObjectByConfiguredName('file_input_class'));
  66                 $ioHandler->setOutputStream(ObjectFactory::createObjectByConfiguredName('file_output_class'));
  67
  68                 // Return instance
  69                 return $ioHandler;
  70         }
  71
  72         /**
  73          * Getter for an instance of this class
  74          *
  75          * @return      $selfInstance   An instance of this class
  76          */
  77         public static final function getSelfInstance () {
  78                 return self::$selfInstance;
  79         }
  80
  81         /**
  82          * Setter for the *real* file input instance
  83          *
  84          * @param       $inputStream    The *real* file-input class
  85          * @return      void
  86          */
  87         public final function setInputStream (FileInputStreamer $inputStream) {
  88                 $this->inputStream = $inputStream;
  89         }
  90
  91         /**
  92          * Getter for the *real* file input instance
  93          *
  94          * @return      $inputStream    The *real* file-input class
  95          */
  96         public final function getInputStream () {
  97                 return $this->inputStream;
  98         }
  99
 100         /**
 101          * Setter for the *real* file output instance
 102          *
 103          * @param       $outputStream   The *real* file-output class
 104          * @return      void
 105          */
 106         public final function setOutputStream (FileOutputStreamer $outputStream) {
 107                 $this->outputStream = $outputStream;
 108         }
 109
 110         /**
 111          * Getter for the *real* file output instance
 112          *
 113          * @return      $outputStream   The *real* file-output class
 114          */
 115         public final function getOutputStream () {
 116                 return $this->outputStream;
 117         }
 118
 119         /**
 120          * Saves a file with data by using the current output stream
 121          *
 122          * @param       $fileName                       Name of the file
 123          * @param       $dataStream                     File data stream
 124          * @param       $objectInstance         An instance of a FrameworkInterface class (default: NULL)
 125          * @return      void
 126          */
 127         public function saveFile ($fileName, $dataStream, FrameworkInterface $objectInstance = NULL) {
 128                 // Get output stream
 129                 $outInstance = $this->getOutputStream();
 130
 131                 // Default is this array
 132                 $className = $this->__toString();
 133
 134                 // Is the object instance set?
 135                 if ($objectInstance instanceof FrameworkInterface) {
 136                         // Then use this
 137                         $className = $objectInstance->__toString();
 138                 } // END - if
 139
 140                 // Prepare output array
 141                 $dataArray = array(
 142                         0 => $className,
 143                         1 => $dataStream
 144                 );
 145
 146                 // Send the fileName and dataArray to the output handler
 147                 $outInstance->saveFile($fileName, $dataArray);
 148         }
 149
 150         /** Loads data from a file over the input handler
 151          *
 152          * @param       $fqfn   Given full-qualified file name (FQFN) to load
 153          * @return      $array  Array with the file contents
 154          */
 155         public function loadFileContents ($fqfn) {
 156                 // Get output stream
 157                 $inInstance = $this->getInputStream();
 158
 159                 // Read from the input handler
 160                 return $inInstance->loadFileContents($fqfn);
 161         }
 162 }
 163
 164 // [EOF]
 165 ?>