3 namespace Org\Mxchange\CoreFramework\Handler\Stream;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
7 use Org\Mxchange\CoreFramework\Stream\Filesystem\FileInputStreamer;
8 use Org\Mxchange\CoreFramework\Stream\Filesystem\FileOutputStreamer;
14 * An interface for I/O handlers
16 * @author Roland Haeder <webmaster@shipsimu.org>
18 <<<<<<< HEAD:framework/main/interfaces/io/file/handler/class_IoHandler.php
19 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
21 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
22 >>>>>>> Some updates::inc/main/interfaces/io/file/handler/class_IoHandler.php
23 * @license GNU GPL 3.0 or any newer version
24 * @link http://www.shipsimu.org
26 * This program is free software: you can redistribute it and/or modify
27 * it under the terms of the GNU General Public License as published by
28 * the Free Software Foundation, either version 3 of the License, or
29 * (at your option) any later version.
31 * This program is distributed in the hope that it will be useful,
32 * but WITHOUT ANY WARRANTY; without even the implied warranty of
33 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
34 * GNU General Public License for more details.
36 * You should have received a copy of the GNU General Public License
37 * along with this program. If not, see <http://www.gnu.org/licenses/>.
39 interface IoHandler extends FileInputStreamer, FileOutputStreamer {
42 * Setter for the *real* file input instance
44 * @param $inputStream The *real* file-input class
47 function setInputStream (FileInputStreamer $inputStream);
50 * Getter for the *real* file input instance
52 * @return $inputStream The *real* file-input class
54 function getInputStream ();
57 * Setter for the *real* file output instance
59 * @param $outputStream The *real* file-output class
62 function setOutputStream (FileOutputStreamer $outputStream);
65 * Getter for the *real* file output instance
67 * @return $outputStream The *real* file-output class
69 function getOutputStream ();
72 * Saves a file with data by using the current output stream
74 * @param $infoInstance An instance of a SplFileInfo class
75 * @param $dataStream File data stream
76 * @param $objectInstance An instance of a FrameworkInterface class (default: NULL)
79 function saveStreamToFile (SplFileInfo $infoInstance, $dataStream, FrameworkInterface $objectInstance = NULL);