87894bd82ce87fa7c0be9911721f9e07c8144c01
[core.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, 2009 - 2011 Core Developer Team
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
35         /**
36          * Create a new compressor channel based a given compression handler
37          *
38          * @return      $cInstance      An instance of this class
39          */
40         public static final function createGzipCompressor () {
41                 // Get new instance
42                 if ((function_exists('gzcompress')) && (function_exists('gzuncompress'))) {
43                         // Compressor can maybe be used
44                         $cInstance = new GzipCompressor();
45                 } else {
46                         // Routines not found!
47                         $cInstance = null;
48                 }
49
50                 // Return the compressor instance
51                 return $cInstance;
52         }
53
54         /**
55          * GZIP compression stream
56          *
57          * @param       $streamData             Mixed non-object stream data
58          * @return      $streamData             The compressed stream data      
59          * @throws      InvalidObjectException  If the stream is an object
60          */
61         public function compressStream ($streamData) {
62                 if (is_object($streamData)) {
63                         // Throw an exception
64                         throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
65                 }
66
67                 // Return the compressed stream
68                 return gzcompress($streamData, 1);
69         }
70
71         /**
72          * GZIP decompression stream
73          *
74          * @param       $streamData             Mixed non-object stream data
75          * @return      $streamData             The decompressed stream data    
76          * @throws      InvalidObjectException  If the stream is an object
77          */
78         public function decompressStream ($streamData) {
79                 if (is_object($streamData)) {
80                         // Throw an exception
81                         throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
82                 }
83
84                 // Return the decompressed stream
85                 return gzuncompress($streamData);
86         }
87
88         /**
89          * Getter for the file extension of this compressor
90          *
91          * @return      $string         Returns always 'gz'
92          */
93         public final function getCompressorExtension () {
94                 return 'gz';
95         }
96 }
97
98 // [EOF]
99 ?>