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
9 * @link http://www.ship-simu.org
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.
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.
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/>.
24 class GzipCompressor extends BaseFrameworkSystem implements Compressor {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor!
32 parent::__construct(__CLASS__);
35 $this->setObjectDescription("GZIP compressor");
37 // Create an unique ID
38 $this->generateUniqueId();
42 * Create a new compressor channel based a given compression handler
44 * @return $cInstance An instance of this class
46 public final static function createGzipCompressor () {
48 if ((function_exists('gzcompress')) && (function_exists('gzuncompress'))) {
49 // Compressor can maybe be used
50 $cInstance = new GzipCompressor();
52 // Routines not found!
56 // Return the compressor instance
61 * GZIP compression stream
63 * @param $streamData Mixed non-object stream data
64 * @return $streamData The compressed stream data
65 * @throws InvalidObjectException If the stream is an object
67 public function compressStream ($streamData) {
68 if (is_object($streamData)) {
70 throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
73 // Return the compressed stream
74 return gzcompress($streamData, 1);
78 * GZIP decompression stream
80 * @param $streamData Mixed non-object stream data
81 * @return $streamData The decompressed stream data
82 * @throws InvalidObjectException If the stream is an object
84 public function decompressStream ($streamData) {
85 if (is_object($streamData)) {
87 throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
90 // Return the decompressed stream
91 return gzuncompress($streamData);
95 * Getter for the file extension of this compressor
97 * @return $string Returns always "gz"
99 public final function getCompressorExtension () {