Code merge from latest ship-simu code
[mailer.git] / inc / classes / main / compressor / class_GzipCompressor.php
1 <?php
2 /**
3  * GZIP compression and decompression class
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
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
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 class GzipCompressor extends BaseFrameworkSystem implements Compressor {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor!
32                 parent::__construct(__CLASS__);
33
34                 // Set description
35                 $this->setObjectDescription("GZIP compressor");
36
37                 // Create an unique ID
38                 $this->createUniqueID();
39         }
40
41         /**
42          * Create a new compressor channel based a given compression handler
43          *
44          * @return      $cInstance      An instance of this class
45          */
46         public final static function createGzipCompressor () {
47                 // Get new instance
48                 if ((function_exists('gzcompress')) && (function_exists('gzuncompress'))) {
49                         // Compressor can maybe be used
50                         $cInstance = new GzipCompressor();
51                 } else {
52                         // Routines not found!
53                         $cInstance = null;
54                 }
55
56                 // Return the compressor instance
57                 return $cInstance;
58         }
59
60         /**
61          * GZIP compression stream
62          *
63          * @param       $streamData             Mixed non-object stream data
64          * @return      $streamData             The compressed stream data      
65          * @throws      InvalidObjectException  If the stream is an object
66          */
67         public function compressStream ($streamData) {
68                 if (is_object($streamData)) {
69                         // Throw an exception
70                         throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
71                 }
72
73                 // Return the compressed stream
74                 return gzcompress($streamData, 1);
75         }
76
77         /**
78          * GZIP decompression stream
79          *
80          * @param       $streamData             Mixed non-object stream data
81          * @return      $streamData             The decompressed stream data    
82          * @throws      InvalidObjectException  If the stream is an object
83          */
84         public function decompressStream ($streamData) {
85                 if (is_object($streamData)) {
86                         // Throw an exception
87                         throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
88                 }
89
90                 // Return the decompressed stream
91                 return gzuncompress($streamData);
92         }
93
94         /**
95          * Getter for the file extension of this compressor
96          *
97          * @return      $string Returns always "gz"
98          */
99         public final function getCompressorExtension () {
100                 return "gz";
101         }
102 }
103
104 // [EOF]
105 ?>