]> git.mxchange.org Git - core.git/blob - framework/main/interfaces/io/file/handler/class_IoHandler.php
Some updates:
[core.git] / framework / main / interfaces / io / file / handler / class_IoHandler.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Handler\Stream;
4
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;
9
10 // Import SPL stuff
11 use \SplFileInfo;
12
13 /**
14  * An interface for I/O handlers
15  *
16  * @author              Roland Haeder <webmaster@shipsimu.org>
17  * @version             0.0.0
18 <<<<<<< HEAD:framework/main/interfaces/io/file/handler/class_IoHandler.php
19  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
20 =======
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
25  *
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.
30  *
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.
35  *
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/>.
38  */
39 interface IoHandler extends FileInputStreamer, FileOutputStreamer {
40
41         /**
42          * Setter for the *real* file input instance
43          *
44          * @param       $inputStream    The *real* file-input class
45          * @return      void
46          */
47         function setInputStream (FileInputStreamer $inputStream);
48
49         /**
50          * Getter for the *real* file input instance
51          *
52          * @return      $inputStream    The *real* file-input class
53          */
54         function getInputStream ();
55
56         /**
57          * Setter for the *real* file output instance
58          *
59          * @param       $outputStream   The *real* file-output class
60          * @return      void
61          */
62         function setOutputStream (FileOutputStreamer $outputStream);
63
64         /**
65          * Getter for the *real* file output instance
66          *
67          * @return      $outputStream   The *real* file-output class
68          */
69         function getOutputStream ();
70
71         /**
72          * Saves a file with data by using the current output stream
73          *
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)
77          * @return      void
78          */
79         function saveStreamToFile (SplFileInfo $infoInstance, $dataStream, FrameworkInterface $objectInstance = NULL);
80
81 }