3 * An interface for streams
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 interface IoHandler extends FrameworkInterface {
26 * Setter for the *real* file input instance
28 * @param $inputStream The *real* file-input class
31 function setInputStream (FileInputStreamer $inputStream);
34 * Getter for the *real* file input instance
36 * @return $inputStream The *real* file-input class
38 function getInputStream ();
41 * Setter for the *real* file output instance
43 * @param $outputStream The *real* file-output class
46 function setOutputStream (FileOutputStreamer $outputStream);
49 * Getter for the *real* file output instance
51 * @return $outputStream The *real* file-output class
53 function getOutputStream ();
56 * Saves a file with data by using the current output stream
58 * @param $fileName Name of the file
59 * @param $dataStream File data stream
60 * @param $objectInstance An instance of a FrameworkInterface class (default: NULL)
63 function saveFile ($fileName, $dataStream, FrameworkInterface $objectInstance = NULL);
65 /** Loads data from a file over the input handler
67 * @param $fqfn Given full-qualified file name (FQFN) to load
68 * @return $array Array with the file contents
70 function loadFileContents ($fqfn);