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