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.
6 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
25 class FileIoHandler extends BaseMiddleware {
27 * The *real* file input class we shall use for reading data
29 private $inputStream = null;
32 * The *real* file output class we shall use for reading data
34 private $outputStream = null;
37 * An instance of this class
39 private static $thisInstance = null;
42 * Protected constructor
46 protected function __construct () {
47 // Call parent constructor
48 parent::__construct(__CLASS__);
51 $this->setObjectDescription("Datei-Ein-/Ausgabe-Handler");
53 // Create an unique ID
54 $this->generateUniqueId();
57 self::$thisInstance = $this;
61 * Creates an instance of this class and prepares the IO system. This is
62 * being done by setting the default file IO class
64 * @return $ioInstance A prepared instance of FilIOHandler
66 public final static function createFileIoHandler () {
68 $ioHandler = new FileIoHandler();
70 // Set the *real* file IO instances (both the same)
71 $ioHandler->setInputStream(ObjectFactory::createObjectByConfiguredName('file_input_stream'));
72 $ioHandler->setOutputStream(ObjectFactory::createObjectByConfiguredName('file_output_stream'));
79 * Getter for an instance of this class
81 * @return $thisInstance An instance of this class
83 public final static function getInstance () {
84 return self::$thisInstance;
88 * Setter for the *real* file input instance
90 * @param $inputStream The *real* file-input class
92 public final function setInputStream (FileInputStreamer $inputStream) {
93 $this->inputStream = $inputStream;
97 * Getter for the *real* file input instance
99 * @return $inputStream The *real* file-input class
101 public final function getInputStream () {
102 return $this->inputStream;
106 * Setter for the *real* file output instance
108 * @param $outputStream The *real* file-output class
110 public final function setOutputStream (FileOutputStreamer $outputStream) {
111 $this->outputStream = $outputStream;
115 * Getter for the *real* file output instance
117 * @return $outputStream The *real* file-output class
119 public final function getOutputStream () {
120 return $this->outputStream;
124 * Saves a file with data by using the current output stream
126 * @see FileOutputStreamer
128 public function saveFile ($fileName, $dataArray) {
130 $outInstance = $this->getOutputStream();
132 // Is it a valid stream?
133 if (is_null($outInstance)) {
135 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
136 } elseif (!is_object($outInstance)) {
137 // Not an object! ;-(
138 throw new NoObjectException($outInstance, self::EXCEPTION_IS_NO_OBJECT);
139 } elseif (!method_exists($outInstance, 'saveFile')) {
140 // Nope, so throw exception
141 throw new MissingMethodException(array($outInstance, 'saveFile'), self::EXCEPTION_MISSING_METHOD);
144 // Send the fileName and dataArray to the output handler
145 $outInstance->saveFile($fileName, $dataArray);
148 /** Loads data from a file over the input handler
150 * @see FileInputStreamer
152 public function loadFileContents ($fqfn) {
153 // Initialize the array
157 $inInstance = $this->getInputStream();
159 // Is it a valid stream?
160 if (is_null($inInstance)) {
162 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
163 } elseif (!is_object($inInstance)) {
164 // Not an object! ;-(
165 throw new NoObjectException($inInstance, self::EXCEPTION_IS_NO_OBJECT);
166 } elseif (!method_exists($inInstance, 'loadFileContents')) {
167 // Nope, so throw exception
168 throw new MissingMethodException(array($inInstance, 'loadFileContents'), self::EXCEPTION_MISSING_METHOD);
171 // Read from the input handler
172 return $inInstance->loadFileContents($fqfn);