3 namespace CoreFramework\Handler\Stream;
5 // Import framework stuff
6 use CoreFramework\Generic\FrameworkInterface;
7 use CoreFramework\Stream\Filesystem\FileInputStreamer;
8 use CoreFramework\Stream\Filesystem\FileOutputStreamer;
11 * An interface for I/O handlers
13 * @author Roland Haeder <webmaster@shipsimu.org>
15 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
16 * @license GNU GPL 3.0 or any newer version
17 * @link http://www.shipsimu.org
19 * This program is free software: you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation, either version 3 of the License, or
22 * (at your option) any later version.
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
32 interface IoHandler extends FileInputStreamer, FileOutputStreamer {
34 * Setter for the *real* file input instance
36 * @param $inputStream The *real* file-input class
39 function setInputStream (FileInputStreamer $inputStream);
42 * Getter for the *real* file input instance
44 * @return $inputStream The *real* file-input class
46 function getInputStream ();
49 * Setter for the *real* file output instance
51 * @param $outputStream The *real* file-output class
54 function setOutputStream (FileOutputStreamer $outputStream);
57 * Getter for the *real* file output instance
59 * @return $outputStream The *real* file-output class
61 function getOutputStream ();
64 * Saves a file with data by using the current output stream
66 * @param $fileName Name of the file
67 * @param $dataStream File data stream
68 * @param $objectInstance An instance of a FrameworkInterface class (default: NULL)
71 function saveStreamToFile ($fileName, $dataStream, FrameworkInterface $objectInstance = NULL);