inc/main/interfaces/compressor/class_Compressor.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Compression;
   4
   5 // Load framework stuff
   6 use CoreFramework\Generic\FrameworkInterface;
   7
   8 /**
   9  * An interface for compression classes
  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 Compressor extends FrameworkInterface {
  31         /**
  32          * A compression stream
  33          *
  34          * @param       $streamData             Mixed non-object stream data
  35          * @return      $streamData             The compressed stream data
  36          * @throws      InvalidObjectException  If the stream is an object
  37          */
  38         function compressStream ($streamData);
  39
  40         /**
  41          * A decompression stream
  42          *
  43          * @param       $streamData             Mixed non-object stream data
  44          * @return      $streamData             The decompressed stream data
  45          * @throws      InvalidObjectException  If the stream is an object
  46          */
  47         function decompressStream ($streamData);
  48
  49         /**
  50          * Getter for the file extension of this compressor
  51          *
  52          * @return      $string The compressor's file extension
  53          */
  54         function getCompressorExtension ();
  55
  56 }