inc/main/interfaces/io/file/handler/class_IoHandler.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Handler\Stream;
   4
   5 // Import framework stuff
   6 use CoreFramework\Generic\FrameworkInterface;
   7 use CoreFramework\Stream\Filesystem\FileInputStreamer;
   8 use CoreFramework\Stream\Filesystem\FileOutputStreamer;
   9
  10 /**
  11  * An interface for I/O handlers
  12  *
  13  * @author              Roland Haeder <webmaster@shipsimu.org>
  14  * @version             0.0.0
  15  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  16  * @license             GNU GPL 3.0 or any newer version
  17  * @link                http://www.shipsimu.org
  18  *
  19  * This program is free software: you can redistribute it and/or modify
  20  * it under the terms of the GNU General Public License as published by
  21  * the Free Software Foundation, either version 3 of the License, or
  22  * (at your option) any later version.
  23  *
  24  * This program is distributed in the hope that it will be useful,
  25  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  * GNU General Public License for more details.
  28  *
  29  * You should have received a copy of the GNU General Public License
  30  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  31  */
  32 interface IoHandler extends FileInputStreamer, FileOutputStreamer {
  33         /**
  34          * Setter for the *real* file input instance
  35          *
  36          * @param       $inputStream    The *real* file-input class
  37          * @return      void
  38          */
  39         function setInputStream (FileInputStreamer $inputStream);
  40
  41         /**
  42          * Getter for the *real* file input instance
  43          *
  44          * @return      $inputStream    The *real* file-input class
  45          */
  46         function getInputStream ();
  47
  48         /**
  49          * Setter for the *real* file output instance
  50          *
  51          * @param       $outputStream   The *real* file-output class
  52          * @return      void
  53          */
  54         function setOutputStream (FileOutputStreamer $outputStream);
  55
  56         /**
  57          * Getter for the *real* file output instance
  58          *
  59          * @return      $outputStream   The *real* file-output class
  60          */
  61         function getOutputStream ();
  62
  63         /**
  64          * Saves a file with data by using the current output stream
  65          *
  66          * @param       $fileName                       Name of the file
  67          * @param       $dataStream                     File data stream
  68          * @param       $objectInstance         An instance of a FrameworkInterface class (default: NULL)
  69          * @return      void
  70          */
  71         function saveStreamToFile ($fileName, $dataStream, FrameworkInterface $objectInstance = NULL);
  72
  73 }