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

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