inc/classes/interfaces/compressor/class_Compressor.php

   1 <?php
   2 /**
   3  * An interface for compression classes
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0
   7  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  */
  23 interface Compressor extends FrameworkInterface {
  24         /**
  25          * A compression stream
  26          *
  27          * @param               $streamData                     Mixed non-object stream data
  28          * @return      $streamData                     The compressed stream data
  29          * @throws      InvalidObjectException  If the stream is an object
  30          */
  31         function compressStream ($streamData);
  32
  33         /**
  34          * A decompression stream
  35          *
  36          * @param               $streamData                     Mixed non-object stream data
  37          * @return      $streamData                     The decompressed stream data
  38          * @throws      InvalidObjectException  If the stream is an object
  39          */
  40         function decompressStream ($streamData);
  41
  42         /**
  43          * Getter for the file extension of this compressor
  44          *
  45          * @return      $string The compressor's file extension
  46          */
  47         function getCompressorExtension ();
  48 }
  49
  50 // [EOF]
  51 ?>