TODO: We should find something better than BaseFrameworkSystem as a type-hint
[shipsimu.git] / ship-simu / inc / classes / interfaces / io / output / class_OutputStreamer.php
1 <?php
2 /**
3  * An interface for output streams
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0
7  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
8  * @license             GNU GPL 3.0 or any newer version
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22  */
23 interface OutputStreamer extends Streamable {
24         /**
25          * Assigns a variable for output
26          *
27          * @param               $var            The variable we shall assign
28          * @param               $value  The value to store in the variable
29          * @return      void
30          */
31         function assignVariable($var, $value);
32
33         /**
34          * Output the code
35          *
36          * @return      void
37          */
38         function output($outStream=false);
39 }
40
41 //
42 ?>