3 * Null compression and decompression class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software
8 * @license GNU GPL 3.0 or any newer version
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 class NullCompressor extends BaseFrameworkSystem implements Compressor {
29 private function __construct () {
30 // Call parent constructor!
31 parent::constructor(__CLASS__);
34 if (((defined('DEBUG_COMPRESSOR')) || (defined('DEBUG_ALL'))) && (defined('DEBUG_CONSTRUCT'))) $this->getDebugInstance()->output(sprintf("[%s:] Konstruktor erreicht.<br />\n",
39 $this->setPartDescr("Null-Kompressor");
41 // Create an unique ID
42 $this->createUniqueID();
46 * Create a new compressor channel based a given compression handler
48 * @return $cInstance An instance of this class
50 public final static function createNullCompressor () {
52 $cInstance = new NullCompressor();
54 // Return the compressor instance
59 * Null compression stream
61 * @param $streamData Mixed non-object stream data
62 * @return $streamData The compressed stream data
63 * @throws InvalidObjectException If the stream is an object
65 public function compressStream ($streamData) {
66 if (is_object($streamData)) {
68 throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
71 // Return the compressed stream
76 * Null decompression stream
78 * @param $streamData Mixed non-object stream data
79 * @return $streamData The decompressed stream data
80 * @throws InvalidObjectException If the stream is an object
82 public function decompressStream ($streamData) {
83 if (is_object($streamData)) {
85 throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
88 // Return the decompressed stream
93 * Getter for the file extension of this compressor
95 * @return $string Returns always "bz2"
97 public final function getCompressorExtension () {
98 if ((defined('DEBUG_COMPRESSOR')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:] Dateierweiterung angefordert.<br />\n",