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

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