3 * An interface for compression classes
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software
8 * @license GNU GPL 3.0 or any newer version
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.
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.
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/>.
23 interface Compressor extends FrameworkInterface {
25 * A compression stream
27 * @param $streamData Mixed non-object stream data
28 * @return $streamData The compressed stream data
29 * @throws InvalidObjectException If the stream is an object
31 function compressStream ($streamData);
34 * A decompression stream
36 * @param $streamData Mixed non-object stream data
37 * @return $streamData The decompressed stream data
38 * @throws InvalidObjectException If the stream is an object
40 function decompressStream ($streamData);
43 * Getter for the file extension of this compressor
45 * @return $string The compressor's file extension
47 function getCompressorExtension ();