Added new interfaces for file i/o classes.
[core.git] / inc / classes / interfaces / io / pointer / class_OutputPointer.php
1 <?php
2 /**
3  * An interface for (mostly) file output pointers.
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.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 OutputPointer extends Streamable {
25         /**
26          * Write data to a file pointer
27          *
28          * @param       $dataStream             The data stream we shall write to the file
29          * @return      mixed                   Number of writes bytes or FALSE on error
30          * @throws      NullPointerException    If the file pointer instance
31          *                                                                      is not set by setPointer()
32          * @throws      InvalidResourceException        If there is being set
33          *                                                                                      an invalid file resource
34          */
35         function writeToFile ($dataStream);
36 }
37
38 // [EOF]
39 ?>