3 * BZIP2 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
9 * @link http://www.mxchange.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class Bzip2Compressor extends BaseFrameworkSystem implements Compressor {
30 private function __construct () {
31 // Call parent constructor!
32 parent::constructor(__CLASS__);
35 if (((defined('DEBUG_COMPRESSOR')) || (defined('DEBUG_ALL'))) && (defined('DEBUG_CONSTRUCT'))) $this->getDebugInstance()->output(sprintf("[%s:] Konstruktor erreicht.<br />\n",
40 $this->setObjectDescription("BZIP2-Kompressor");
42 // Create an unique ID
43 $this->createUniqueID();
47 * Create a new compressor channel based a given compression handler
49 * @return $cInstance An instance of this class
51 public final static function createBzip2Compressor () {
53 if ((function_exists('bzcompress')) && (function_exists('bzdecompress'))) {
54 // Compressor can maybe be used
55 $cInstance = new Bzip2Compressor();
58 if ((defined('DEBUG_COMPRESSOR')) || (defined('DEBUG_ALL'))) $cInstance->getDebugInstance()->output(sprintf("[%s:] BZIP2-Kompression wird verwendet.<br />\n",
59 $cInstance->__toString()
62 // Routines not found!
66 if ((defined('DEBUG_COMPRESSOR')) || (defined('DEBUG_ALL'))) $cInstance->getDebugInstance()->output(sprintf("[%s:] BZIP2-Kompressionsroutinen <strong>nicht</strong> gefunden.<br />\n",
67 $cInstance->__toString()
71 // Return the compressor instance
76 * BZIP2 compression stream
78 * @param $streamData Mixed non-object stream data
79 * @return $streamData The compressed stream data
80 * @throws InvalidObjectException If the stream is an object
82 public function compressStream ($streamData) {
83 if (is_object($streamData)) {
85 throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
88 // Return the compressed stream
89 return bzcompress($streamData, 1);
93 * BZIP2 decompression stream
95 * @param $streamData Mixed non-object stream data
96 * @return $streamData The decompressed stream data
97 * @throws InvalidObjectException If the stream is an object
99 public function decompressStream ($streamData) {
100 if (is_object($streamData)) {
101 // Throw an exception
102 throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
105 // Return the decompressed stream
106 return bzdecompress($streamData);
110 * Getter for the file extension of this compressor
112 * @return $string Returns always "bz2"
114 public final function getCompressorExtension () {
115 if ((defined('DEBUG_COMPRESSOR')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:] Dateierweiterung angefordert.<br />\n",