403e6625b415644450b53778b35a68c69c22c91c
[core.git] / framework / main / interfaces / io / pointer / class_OutputPointer.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Filesystem\Pointer;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Filesystem\FilePointer;
7 use Org\Mxchange\CoreFramework\Stream\Output\StreamableOutput;
8
9 /**
10  * An interface for (mostly) file output pointers.
11  *
12  * @author              Roland Haeder <webmaster@shipsimu.org>
13  * @version             0.0.0
14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
15  * @license             GNU GPL 3.0 or any newer version
16  * @link                http://www.shipsimu.org
17  *
18  * This program is free software: you can redistribute it and/or modify
19  * it under the terms of the GNU General Public License as published by
20  * the Free Software Foundation, either version 3 of the License, or
21  * (at your option) any later version.
22  *
23  * This program is distributed in the hope that it will be useful,
24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
26  * GNU General Public License for more details.
27  *
28  * You should have received a copy of the GNU General Public License
29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
30  */
31 interface OutputPointer extends StreamableOutput, FilePointer {
32         /**
33          * Write data to a file pointer
34          *
35          * @param       $dataStream             The data stream we shall write to the file
36          * @return      mixed                   Number of writes bytes or false on error
37          * @throws      NullPointerException    If the file pointer instance
38          *                                                                      is not set by setPointer()
39          * @throws      InvalidResourceException        If there is being set
40          *                                                                                      an invalid file resource
41          */
42         function writeToFile ($dataStream);
43
44         /**
45          * Writes at given position by seeking to it.
46          *
47          * @param       $seekPosition   Seek position in file
48          * @param       $data                   Data to be written
49          * @return      mixed                   Number of writes bytes or false on error
50          */
51         function writeAtPosition ($seedPosition, $data);
52
53 }