inc/main/interfaces/io/pointer/class_OutputPointer.php

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