]> git.mxchange.org Git - core.git/blob - framework/main/classes/compressor/class_ZlibCompressor.php
Continued:
[core.git] / framework / main / classes / compressor / class_ZlibCompressor.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Compressor\Zlib;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Compressor\Compressor;
7 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
8
9 /**
10  * ZLIB compression and decompression class
11  *
12  * @author              Roland Haeder <webmaster@shipsimu.org>
13  * @version             0.0.0
14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
15  * @license             GNU GPL 3.0 or any newer version
16  * @link                http://www.shipsimu.org
17  *
18  * This program is free software: you can redistribute it and/or modify
19  * it under the terms of the GNU General Public License as published by
20  * the Free Software Foundation, either version 3 of the License, or
21  * (at your option) any later version.
22  *
23  * This program is distributed in the hope that it will be useful,
24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
26  * GNU General Public License for more details.
27  *
28  * You should have received a copy of the GNU General Public License
29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
30  */
31 class ZlibCompressor extends BaseFrameworkSystem implements Compressor {
32         /**
33          * Protected constructor
34          *
35          * @return      void
36          */
37         protected function __construct () {
38                 // Call parent constructor!
39                 parent::__construct(__CLASS__);
40         }
41
42         /**
43          * Create a new compressor channel based a given compression handler or NULL if the required PHP functions are not found.
44          *
45          * @return      $compressorInstance             An instance of this class or NULL if the required PHP functions are not found.
46          */
47         public static final function createZlibCompressor () {
48                 // Routines not found by default
49                 $compressorInstance = NULL;
50
51                 // Get new instance
52                 if ((function_exists('gzcompress')) && (function_exists('gzuncompress'))) {
53                         // Compressor can maybe be used
54                         $compressorInstance = new ZlibCompressor();
55                 } // END - if
56
57                 // Return the compressor instance
58                 return $compressorInstance;
59         }
60
61         /**
62          * ZLIB compression stream
63          *
64          * @param       $streamData             Mixed non-object stream data
65          * @return      $streamData             The compressed stream data
66          * @throws      InvalidObjectException  If the stream is an object
67          */
68         public function compressStream ($streamData) {
69                 if (is_object($streamData)) {
70                         // Throw an exception
71                         throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
72                 } // END - if
73
74                 // Return the compressed stream
75                 return gzcompress($streamData, 1);
76         }
77
78         /**
79          * ZLIB decompression stream
80          *
81          * @param       $streamData             Mixed non-object stream data
82          * @return      $streamData             The decompressed stream data
83          * @throws      InvalidObjectException  If the stream is an object
84          */
85         public function decompressStream ($streamData) {
86                 if (is_object($streamData)) {
87                         // Throw an exception
88                         throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
89                 } // END - if
90
91                 // Return the decompressed stream
92                 return gzuncompress($streamData);
93         }
94
95         /**
96          * Getter for the file extension of this compressor
97          *
98          * @return      $string         Returns always 'z'
99          */
100         public final function getCompressorExtension () {
101                 return 'z';
102         }
103
104 }