3 namespace Org\Mxchange\CoreFramework\Compressor\Gzip;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Compressor\Compressor;
7 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
10 * GZIP compression and decompression class
12 * @author Roland Haeder <webmaster@shipsimu.org>
14 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
15 * @license GNU GPL 3.0 or any newer version
16 * @link http://www.shipsimu.org
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.
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.
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/>.
31 class GzipCompressor extends BaseFrameworkSystem implements Compressor {
33 * Protected constructor
37 private function __construct () {
38 // Call parent constructor!
39 parent::__construct(__CLASS__);
43 * Create a new compressor channel based a given compression handler or NULL if the required PHP functions are not found.
45 * @return $compressorInstance An instance of this class or NULL if the required PHP functions are not found.
47 public static final function createGzipCompressor () {
48 // Routines not found by default
49 $compressorInstance = NULL;
52 if ((function_exists('gzencode')) && (function_exists('gzdecode'))) {
53 // Compressor can maybe be used
54 $compressorInstance = new GzipCompressor();
57 // Return the compressor instance
58 return $compressorInstance;
62 * GZIP compression stream
64 * @param $streamData Mixed non-object stream data
65 * @return $streamData The compressed stream data
67 public function compressStream (string $streamData) {
69 $streamData = gzencode($streamData, 1);
76 * GZIP decompression stream
78 * @param $streamData Mixed non-object stream data
79 * @return $streamData The decompressed stream data
81 public function decompressStream (string $streamData) {
83 $streamData = gzdecode($streamData);
90 * Getter for the file extension of this compressor
92 * @return $string Returns always 'gz'
94 public final function getCompressorExtension () {