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
   8 /**
   9  * An interface for I/O handlers
  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 IoHandler extends FileInputStreamer, FileOutputStreamer {
  31         /**
  32          * Setter for the *real* file input instance
  33          *
  34          * @param       $inputStream    The *real* file-input class
  35          * @return      void
  36          */
  37         function setInputStream (FileInputStreamer $inputStream);
  38
  39         /**
  40          * Getter for the *real* file input instance
  41          *
  42          * @return      $inputStream    The *real* file-input class
  43          */
  44         function getInputStream ();
  45
  46         /**
  47          * Setter for the *real* file output instance
  48          *
  49          * @param       $outputStream   The *real* file-output class
  50          * @return      void
  51          */
  52         function setOutputStream (FileOutputStreamer $outputStream);
  53
  54         /**
  55          * Getter for the *real* file output instance
  56          *
  57          * @return      $outputStream   The *real* file-output class
  58          */
  59         function getOutputStream ();
  60
  61         /**
  62          * Saves a file with data by using the current output stream
  63          *
  64          * @param       $fileName                       Name of the file
  65          * @param       $dataStream                     File data stream
  66          * @param       $objectInstance         An instance of a FrameworkInterface class (default: NULL)
  67          * @return      void
  68          */
  69         function saveStreamToFile ($fileName, $dataStream, FrameworkInterface $objectInstance = NULL);
  70
  71 }