3 * GZIP compression and decompression class
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 class GzipCompressor extends BaseFrameworkSystem implements Compressor {
29 private function __construct () {
30 // Call parent constructor!
31 parent::constructor(__CLASS__);
34 if (((defined('DEBUG_COMPRESSOR')) || (defined('DEBUG_ALL'))) && (defined('DEBUG_CONSTRUCT'))) $this->getDebugInstance()->output(sprintf("[%s:] Konstruktor erreicht.<br />\n",
39 $this->setPartDescr("GZIP-Kompressor");
41 // Create an unique ID
42 $this->createUniqueID();
46 * Create a new compressor channel based a given compression handler
48 * @return $cInstance An instance of this class
50 public final static function createGzipCompressor () {
52 if ((function_exists('gzcompress')) && (function_exists('gzuncompress'))) {
53 // Compressor can maybe be used
54 $cInstance = new GzipCompressor();
57 if ((defined('DEBUG_COMPRESSOR')) || (defined('DEBUG_ALL'))) $cInstance->getDebugInstance()->output(sprintf("[%s:] GZIP-Kompression wird verwendet.<br />\n",
58 $cInstance->__toString()
61 // Routines not found!
65 if ((defined('DEBUG_COMPRESSOR')) || (defined('DEBUG_ALL'))) $cInstance->getDebugInstance()->output(sprintf("[%s:] GZIP-Kompressionsroutinen <strong>nicht</strong> gefunden.<br />\n",
66 $cInstance->__toString()
70 // Return the compressor instance
75 * GZIP compression stream
77 * @param $streamData Mixed non-object stream data
78 * @return $streamData The compressed stream data
79 * @throws InvalidObjectException If the stream is an object
81 public function compressStream ($streamData) {
82 if (is_object($streamData)) {
84 throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
87 // Return the compressed stream
88 return gzcompress($streamData, 1);
92 * GZIP decompression stream
94 * @param $streamData Mixed non-object stream data
95 * @return $streamData The decompressed stream data
96 * @throws InvalidObjectException If the stream is an object
98 public function decompressStream ($streamData) {
99 if (is_object($streamData)) {
100 // Throw an exception
101 throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
104 // Return the decompressed stream
105 return gzuncompress($streamData);
109 * Getter for the file extension of this compressor
111 * @return $string Returns always "gz"
113 public final function getCompressorExtension () {
114 if ((defined('DEBUG_COMPRESSOR')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:] Dateierweiterung angefordert.<br />\n",