ce29db97c240330f1ae25c3d98b43b39a660f2fe
[core.git] / inc / classes / interfaces / io / class_IoHandler.php
1 <?php
2 /**
3  * An interface for streams
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.org
10  *
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.
15  *
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.
20  *
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/>.
23  */
24 interface Streamable extends FrameworkInterface {
25         /**
26          * Setter for the *real* file input instance
27          *
28          * @param       $inputStream    The *real* file-input class
29          * @return      void
30          */
31         function setInputStream (FileInputStreamer $inputStream);
32
33         /**
34          * Getter for the *real* file input instance
35          *
36          * @return      $inputStream    The *real* file-input class
37          */
38         function getInputStream ();
39
40         /**
41          * Setter for the *real* file output instance
42          *
43          * @param       $outputStream   The *real* file-output class
44          * @return      void
45          */
46         function setOutputStream (FileOutputStreamer $outputStream);
47
48         /**
49          * Getter for the *real* file output instance
50          *
51          * @return      $outputStream   The *real* file-output class
52          */
53         function getOutputStream ();
54
55         /**
56          * Saves a file with data by using the current output stream
57          *
58          * @param       $fileName                       Name of the file
59          * @param       $dataStream                     File data stream
60          * @param       $objectInstance         An instance of a FrameworkInterface class (default: NULL)
61          * @return      void
62          */
63         function saveFile ($fileName, $dataStream, FrameworkInterface $objectInstance = NULL);
64
65         /** Loads data from a file over the input handler
66          *
67          * @param       $fqfn   Given full-qualified file name (FQFN) to load
68          * @return      $array  Array with the file contents
69          */
70         function loadFileContents ($fqfn);
71 }
72
73 // [EOF]
74 ?>