3 namespace CoreFramework\Compressor;
5 // Import framework stuff
6 use CoreFramework\Object\BaseFrameworkSystem;
9 * GZIP compression and decompression class
11 * @author Roland Haeder <webmaster@shipsimu.org>
13 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
14 * @license GNU GPL 3.0 or any newer version
15 * @link http://www.shipsimu.org
17 * This program is free software: you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation, either version 3 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 class GzipCompressor extends BaseFrameworkSystem implements Compressor {
32 * Protected constructor
36 protected function __construct () {
37 // Call parent constructor!
38 parent::__construct(__CLASS__);
42 * Create a new compressor channel based a given compression handler or NULL if the required PHP functions are not found.
44 * @return $compressorInstance An instance of this class or NULL if the required PHP functions are not found.
46 public static final function createGzipCompressor () {
47 // Routines not found by default
48 $compressorInstance = NULL;
51 if ((function_exists('gzencode')) && (function_exists('gzdecode'))) {
52 // Compressor can maybe be used
53 $compressorInstance = new GzipCompressor();
56 // Return the compressor instance
57 return $compressorInstance;
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 gzencode($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 gzdecode($streamData);
95 * Getter for the file extension of this compressor
97 * @return $string Returns always 'gz'
99 public final function getCompressorExtension () {