3 namespace CoreFramework\Compressor\Null;
5 // Import framework stuff
6 use CoreFramework\Compressor\Compressor;
7 use CoreFramework\Object\BaseFrameworkSystem;
10 * Null compression and decompression class
12 * @author Roland Haeder <webmaster@shipsimu.org>
14 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 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 NullCompressor extends BaseFrameworkSystem implements Compressor {
33 * Protected constructor
37 protected function __construct () {
38 // Call parent constructor!
39 parent::__construct(__CLASS__);
43 * Create a new compressor channel based a given compression handler
45 * @return $compressorInstance An instance of this class
47 public static final function createNullCompressor () {
49 $compressorInstance = new NullCompressor();
51 // Return the compressor instance
52 return $compressorInstance;
56 * Null compression stream
58 * @param $streamData Mixed non-object stream data
59 * @return $streamData The compressed stream data
60 * @throws InvalidObjectException If the stream is an object
62 public function compressStream ($streamData) {
63 if (is_object($streamData)) {
65 throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
68 // Return the compressed stream
73 * Null decompression stream
75 * @param $streamData Mixed non-object stream data
76 * @return $streamData The decompressed stream data
77 * @throws InvalidObjectException If the stream is an object
79 public function decompressStream ($streamData) {
80 if (is_object($streamData)) {
82 throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
85 // Return the decompressed stream
90 * Getter for the file extension of this compressor
92 * @return $string Returns always 'null'
94 public final function getCompressorExtension () {