3 * An interface for (mostly) file output pointers.
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
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.
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.
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/>.
24 interface OutputPointer extends StreamableOutput, FilePointer {
26 * Write data to a file pointer
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
35 function writeToFile ($dataStream);
38 * Writes at given position by seeking to it.
40 * @param $seekPosition Seek position in file
41 * @param $data Data to be written
42 * @return mixed Number of writes bytes or FALSE on error
44 function writeAtPosition ($seedPosition, $data);