inc/classes/interfaces/compressor/class_Compressor.php

   1 <?php
   2 /**
   3  * An interface for compression classes
   4  *
   5  * @author      Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
   6  * @version     0.1
   7  */
   8 interface Compressor extends FrameworkInterface {
   9         /**
  10          * A compression stream
  11          *
  12          * @param               $streamData                     Mixed non-object stream data
  13          * @return      $streamData                     The compressed stream data
  14          * @throws      InvalidObjectException  If the stream is an object
  15          */
  16         function compressStream ($streamData);
  17
  18         /**
  19          * A decompression stream
  20          *
  21          * @param               $streamData                     Mixed non-object stream data
  22          * @return      $streamData                     The decompressed stream data
  23          * @throws      InvalidObjectException  If the stream is an object
  24          */
  25         function decompressStream ($streamData);
  26
  27         /**
  28          * Getter for the file extension of this compressor
  29          *
  30          * @return      $string The compressor's file extension
  31          */
  32         function getCompressorExtension ();
  33 }
  34
  35 // [EOF]
  36 ?>