]> git.mxchange.org Git - core.git/blob - framework/main/interfaces/io/pointer/class_OutputPointer.php
Some updates:
[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 <<<<<<< HEAD:framework/main/interfaces/io/pointer/class_OutputPointer.php
15  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
16 =======
17  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
18 >>>>>>> Some updates::inc/main/interfaces/io/pointer/class_OutputPointer.php
19  * @license             GNU GPL 3.0 or any newer version
20  * @link                http://www.shipsimu.org
21  *
22  * This program is free software: you can redistribute it and/or modify
23  * it under the terms of the GNU General Public License as published by
24  * the Free Software Foundation, either version 3 of the License, or
25  * (at your option) any later version.
26  *
27  * This program is distributed in the hope that it will be useful,
28  * but WITHOUT ANY WARRANTY; without even the implied warranty of
29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
30  * GNU General Public License for more details.
31  *
32  * You should have received a copy of the GNU General Public License
33  * along with this program. If not, see <http://www.gnu.org/licenses/>.
34  */
35 interface OutputPointer extends StreamableOutput, FilePointer {
36         /**
37          * Write data to a file pointer
38          *
39          * @param       $dataStream             The data stream we shall write to the file
40          * @return      mixed                   Number of writes bytes or false on error
41          * @throws      NullPointerException    If the file pointer instance
42          *                                                                      is not set by setPointer()
43          * @throws      InvalidResourceException        If there is being set
44          *                                                                                      an invalid file resource
45          */
46         function writeToFile ($dataStream);
47
48         /**
49          * Writes at given position by seeking to it.
50          *
51          * @param       $seekPosition   Seek position in file
52          * @param       $data                   Data to be written
53          * @return      mixed                   Number of writes bytes or false on error
54          */
55         function writeAtPosition ($seedPosition, $data);
56
57 }