3 namespace CoreFramework\Compressor;
5 // Import framework stuff
6 use CoreFramework\Object\BaseFrameworkSystem;
9 * Null 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 NullCompressor 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
44 * @return $compressorInstance An instance of this class
46 public static final function createNullCompressor () {
48 $compressorInstance = new NullCompressor();
50 // Return the compressor instance
51 return $compressorInstance;
55 * Null compression stream
57 * @param $streamData Mixed non-object stream data
58 * @return $streamData The compressed stream data
59 * @throws InvalidObjectException If the stream is an object
61 public function compressStream ($streamData) {
62 if (is_object($streamData)) {
64 throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
67 // Return the compressed stream
72 * Null decompression stream
74 * @param $streamData Mixed non-object stream data
75 * @return $streamData The decompressed stream data
76 * @throws InvalidObjectException If the stream is an object
78 public function decompressStream ($streamData) {
79 if (is_object($streamData)) {
81 throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
84 // Return the decompressed stream
89 * Getter for the file extension of this compressor
91 * @return $string Returns always 'null'
93 public final function getCompressorExtension () {