Launcher scripts updated
[mailer.git] / 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@ship-simu.org>
7  * @version             0.0.0
8  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
9  * @license             GNU GPL 3.0 or any newer version
10  * @link                http://www.ship-simu.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 {
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 $thisInstance = 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::$thisInstance = $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 final static 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      $thisInstance   An instance of this class
76          */
77         public final static function getInstance () {
78                 return self::$thisInstance;
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       $dataArray      Array with file contents
124          * @return      void
125          * @see         FileOutputStreamer
126          */
127         public function saveFile ($fileName, $dataArray) {
128                 // Get output stream
129                 $outInstance = $this->getOutputStream();
130
131                 // Send the fileName and dataArray to the output handler
132                 $outInstance->saveFile($fileName, $dataArray);
133         }
134
135         /** Loads data from a file over the input handler
136          *
137          * @return      $array  Array with the file contents
138          * @see         FileInputStreamer
139          */
140         public function loadFileContents ($fqfn) {
141                 // Get output stream
142                 $inInstance = $this->getInputStream();
143
144                 // Read from the input handler
145                 return $inInstance->loadFileContents($fqfn);
146         }
147 }
148
149 // [EOF]
150 ?>